"ToolNetApi"
Calculates the holder profile.
The code.
The Profile result.
Calculates the dxf profile and outputs additional data.
The profile parameters.
[out] The maximum dia.
[out] Length of the maximum.
[out] Depth of the cut.
The Profile result.
Calculates the profile.
The profile calculation parameters.
The Profile result.
Service class providing functionality to build custom 2D profiles from DXF files for mill tools and
holders.
A set of parameters required for building tool component profiles from DXF files.
Performs an action on a loaded DXF Import module.
The action.
Options for controlling the profile.
Profile result.
Searches for the first chain maximum x coordinate.
[in] The profile.
The found chain maximum x coordinate.
Searches for the first chain maximum y coordinate.
[in] The profile.
The found chain maximum y coordinate.
Scale profile.
[in] The profile.
The scale.
Orient profile.
[in] The cut profile.
The maximum x coordinate.
Calculates the holder profile.
The code.
The Profile result.
Calculates the dxf profile and outputs additional data.
The profile parameters.
[out] The maximum dia.
[out] Length of the maximum.
[out] Depth of the cut.
The Profile result.
Calculates the profile.
The profile calculation parameters.
The Profile result.
Service class providing functionality to build custom 2D profiles from DXF files for mill tools and
holders.
A set of parameters required for building tool component profiles from DXF files.
Gets TlAssembly factory.
nullptr if it fails, else the TlAssembly factory.
Gets TlAssemblyItem factory.
nullptr if it fails, else theTlAssemblyItem factory.
Gets tool system interface.
The tool system interface.
Implementation of the main Mastercam tool system.
Query if the main part tool list is empty.
true if empty, false if not.
Launches the Classic Tool Manager Dialog.
True to launch the lathe tool manager. False to launch the mill tool manager.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) If non-null, (Optional) the parent.
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, defaults to -1) If the holder is a composite holder, the index of the holder to edit.
(Optional, defaults to null) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the tool wizard to edit the holder 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, defaults to false) true to start on the last page (properties page) of the wizard.
(Optional) true to present the editor in read-only mode.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to false) true to launch the editor in a read only mode.
(Optional, defaults to null) 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, defaults to false) true to start on the last page (properites page) of the wizard.
(Optional, defaults to false) true to launch the editor in a read only mode.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to END_MILL) The initial tool type.
(Optional, defaults to null) 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, defaults to false) True if the user should be warned before deleting a tool used by
operations.
(Optional, defaults to false) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional, defaults to null) 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, defaults to false) True if the user should be warned before deleting a tool used by
operations.
(Optional, defaults to false) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional, defaults to null) 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 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, defaults to true) true to warning on similar tools.
(Optional, defaults to true) true to add if similar exists.
(Optional, defaults to true) true to initialize offsets.
(Optional, defaults to false) 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, defaults to true) true to warning on similar tools.
(Optional, defaults to true) true to add if similar exists.
(Optional, defaults to true) true to initialize offsets.
(Optional, defaults to false) true to suppress tool number warning.
true if it succeeds, false if it fails.
Adds input.
The input to add.
true if it succeeds, false if it fails.
Adds input.
The input to add.
true if it succeeds, false if it fails.
Constructor.
Implementation of the main Mastercam tool system.
Query if the main part tool list is empty.
true if empty, false if not.
Launches the Classic Tool Manager Dialog.
True to launch the lathe tool manager. False to launch the mill tool manager.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to null) If non-null, (Optional) the parent.
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, defaults to -1) If the holder is a composite holder, the index of the holder to edit.
(Optional, defaults to null) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the tool wizard to edit the holder 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, defaults to false) true to start on the last page (properties page) of the wizard.
(Optional) true to present the editor in read-only mode.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to false) true to launch the editor in a read only mode.
(Optional, defaults to null) 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, defaults to false) true to start on the last page (properites page) of the wizard.
(Optional, defaults to false) true to launch the editor in a read only mode.
(Optional, defaults to null) 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, defaults to null) 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, defaults to null) 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, defaults to END_MILL) The initial tool type.
(Optional, defaults to null) 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, defaults to false) True if the user should be warned before deleting a tool used by
operations.
(Optional, defaults to false) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional, defaults to null) 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, defaults to false) True if the user should be warned before deleting a tool used by
operations.
(Optional, defaults to false) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional, defaults to null) 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 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, defaults to true) true to warning on similar tools.
(Optional, defaults to true) true to add if similar exists.
(Optional, defaults to true) true to initialize offsets.
(Optional, defaults to false) 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, defaults to true) true to warning on similar tools.
(Optional, defaults to true) true to add if similar exists.
(Optional, defaults to true) true to initialize offsets.
(Optional, defaults to false) 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.
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 passed in type and metric flag.
The type.
true for the created mill tool to have metric values.
The new mill tool.
Constructor.
Implementation of the main Mastercam tool system.
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 passed in type and metric flag.
The type.
true for the created mill tool to have metric values.
The new mill tool.
Factory service class providing functionality for creating instances of the classes TlToolMill, TlHolder,
and TlToolLathe.
Calculates the profile.
The profile calculation parameters.
The profile result.
Service class providing functionality to build parametric profiles for milling and holemaking tools.
Parametric profile parameters for milling/hole-making tools.
Makes reduced neck shank above shoulder.
The code.
The profile.
The start.
The start.
Options for controlling the operation.
Makes tapered shank above shoulder.
The code.
The profile.
The start.
The start.
Options for controlling the operation.
Makes straight shank above shoulder.
The code.
The profile.
The start.
The start.
Options for controlling the operation.
Makes shank above shoulder.
The code.
The profile.
The start.
The start.
Options for controlling the operation.
Makes feed mill.
The code.
The profile.
Options for controlling the operation.
Makes a lens barrel form AF tool.
The code.
The profile.
Options for controlling the operation.
Makes a lens form AF tool.
The code.
The profile.
Options for controlling the operation.
Makes a taper form AF tool.
The code.
The profile.
Options for controlling the operation.
Makes oval form AF tool.
The code.
The profile.
Options for controlling the operation.
Makes barrel orm AF tool.
The code.
The profile.
Options for controlling the operation.
Creates an undefined thread profile.
[out] The result code.
[in] The starting Y value for the thread. [out] The ending Y value for the thread.
Options for controlling the operation.
A set of profile segments representing the thread.
Makes npt thread.
The code.
The current Y Value of the thread.
Options for controlling the operation.
A std::vector<TlProfileEnt>
Makes buttress thread.
The code.
The current Y Value of the thread.
Options for controlling the operation.
A std::vector<TlProfileEnt>
Makes ACME thread.
The code.
The current Y Value of the thread.
Options for controlling the operation.
A std::vector<TlProfileEnt>
Makes Unified/ISO thread.
The code.
The current Y Value of the thread.
Options for controlling the operation.
A std::vector<TlProfileEnt>
Makes a thread.
The code.
The current Y Value of the thread.
Options for controlling the operation.
A std::vector<TlProfileEnt>
Makes thread mill.
The code.
The profile.
Options for controlling the operation.
Makes a Counter bore.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a bull end mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a lollipop mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a taper mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes the radius mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a slot mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a face mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a chamfer mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a ball end mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a boring bar.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a dove tail mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a reamer.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a flat end mill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a drill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a center drill.
[in] The code.
[out] The profile.
Options for controlling the operation.
Makes a counter sink or tap or null tool.
[in] The code.
[out] The profile.
Options for controlling the operation.
Check tool validity.
[in] The parameters to validate.
The result code.
Calculates the profile.
The profile calculation parameters.
The profile result.
Service class providing functionality to build parametric profiles for milling and holemaking tools.
Parametric profile parameters for milling/hole-making tools.
Sets PrimaryCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets PrimaryCornerRadius property in the specified units.
true to get value in metric.
ThePrimaryCornerRadius property.
Gets or sets the primary corner radius.
Thread Shape
Number Thread Starts
Radius Type
Sets TipDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets TipDiameter property in the specified units.
true to get value in metric.
TheTipDiameter property.
Tip diameter of Threading Tool.
Thread angle of Threading Tool.
Sets RootDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets RootDiameter property in the specified units.
true to get value in metric.
TheRootDiameter property.
Root diameter of Threading Tool.
Sets ThreadPitch property in the specified units.
value to set.
true to specify value is in metric.
Gets ThreadPitch property in the specified units.
true to get value in metric.
TheThreadPitch property.
Thread pitch of Threading Tool.
Tip angle of the Threading Tool.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Chamfer Angle
Sets SecondaryChamferDist property in the specified units.
value to set.
true to specify value is in metric.
Gets SecondaryChamferDist property in the specified units.
true to get value in metric.
TheSecondaryChamferDist property.
Chamfer Distance
Sets SecondaryCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets SecondaryCornerRadius property in the specified units.
true to get value in metric.
TheSecondaryCornerRadius property.
Corner Radius
Corner Type
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets holemaking operation parameters.
The holemaking operation parameters.
Sets ChamferLength property in the specified units.
value to set.
true to specify value is in metric.
Gets ChamferLength property in the specified units.
true to get value in metric.
TheChamferLength property.
Chamfer Length
Tip Angle
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Identifier for the holder entity.
Identifier for the insert entity.
Type of the tool.
The tool orientation.
Sets NoseRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets NoseRadius property in the specified units.
true to get value in metric.
TheNoseRadius property.
The nose radius.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets milling operation parameters.
The milling operation parameters.
Sets the radius type.
The radius.
Sets the radius type.
The radius.
Gets the radius type.
The radius type.
Sets PrimaryCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets PrimaryCornerRadius property in the specified units.
true to get value in metric.
ThePrimaryCornerRadius property.
Gets or sets the primary corner radius.
Sets ChamferLength property in the specified units.
value to set.
true to specify value is in metric.
Gets ChamferLength property in the specified units.
true to get value in metric.
TheChamferLength property.
ChamferLength
Corner Type
Sets TipDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets TipDiameter property in the specified units.
true to get value in metric.
TheTipDiameter property.
Tip Diameter
Taper Angle
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Sets DrillLength property in the specified units.
value to set.
true to specify value is in metric.
Gets DrillLength property in the specified units.
true to get value in metric.
TheDrillLength property.
Drill Length
Sets DrillDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets DrillDiameter property in the specified units.
true to get value in metric.
TheDrillDiameter property.
Drill Diameter
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Stepover Finish Z
Stepover Finish XY
Stepover Rough Z
Stepover Rough XY
Finish Flag
Rough Flag
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Is multi directional
The insert definition
Type code
Index relief angle
Sets FacingXOvercut property in the specified units.
value to set.
true to specify value is in metric.
Gets FacingXOvercut property in the specified units.
true to get value in metric.
TheFacingXOvercut property.
Facing x coordinate overcut
Sets FacingRetract property in the specified units.
value to set.
true to specify value is in metric.
Gets FacingRetract property in the specified units.
true to get value in metric.
TheFacingRetract property.
Facing retract
Sets RoughOverlap property in the specified units.
value to set.
true to specify value is in metric.
Gets RoughOverlap property in the specified units.
true to get value in metric.
TheRoughOverlap property.
Rough overlap
Sets FinishDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets FinishDepthOfCut property in the specified units.
true to get value in metric.
TheFinishDepthOfCut property.
Finish depth of cut
Sets RoughDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets RoughDepthOfCut property in the specified units.
true to get value in metric.
TheRoughDepthOfCut property.
Rough depth of cut
Relief angle
ANSI cross section code
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Backoff percent
Sets StockClearance property in the specified units.
value to set.
true to specify value is in metric.
Gets StockClearance property in the specified units.
true to get value in metric.
TheStockClearance property.
Stock clearance
Sets FinishDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets FinishDepthOfCut property in the specified units.
true to get value in metric.
TheFinishDepthOfCut property.
Finish depth of cut
Sets RoughDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets RoughDepthOfCut property in the specified units.
true to get value in metric.
TheRoughDepthOfCut property.
Rough depth of cut
End angle
Sets NotchPointLocation property in the specified units.
value to set.
true to specify value is in metric.
Gets NotchPointLocation property in the specified units.
true to get value in metric.
TheNotchPointLocation property.
Notch point location
Sets EndLength property in the specified units.
value to set.
true to specify value is in metric.
Gets EndLength property in the specified units.
true to get value in metric.
TheEndLength property.
End length
Sets ShankWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ShankWidth property in the specified units.
true to get value in metric.
TheShankWidth property.
Shank width
Sets CutLength property in the specified units.
value to set.
true to specify value is in metric.
Gets CutLength property in the specified units.
true to get value in metric.
TheCutLength property.
Cut length
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
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.
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.
Transforms the current segment by the given transformation.
The transformation.
Type of the transform.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
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.
Constructor.
The endpoint 1 x coordinate.
The endpoint 1 y coordinate.
The endpoint 2 x coordinate.
The endpoint 2 y coordinate.
The color.
Constructor.
The segment.
The color.
Default constructor.
Turns an arc into a set of lines
arc to linearize.
a set of lines
Normalizes the arc to avoid bizarre construction. Should be called whenever arc is set
Get y coordinate value intersection angles.
The value.
The y coordinate value intersection angles.
Get x coordinate value intersection angles.
The value.
The x coordinate value intersection angles.
Gets the point at the specified angle.
The angle.
The point at the specified angle on the arc.
Determines the angle to which the arc sweeps
Final angle of sweep in radians
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.
Transforms the given transformation.
The transformation.
Type of the transform.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
Gets maximum width.
The maximum width.
Gets top width using just the endpoints of the arc.
The top width.
Gets bottom width using just the endpoints of the arc.
The bottom width.
Height of segment
said height
Gets the length of this profile segment.
The length.
Query if this object is convex.
true if convex, false if not.
Query if arc sweeps completely between 270 degrees to 90 degrees (inclusive).
true if it succeeds, false if it fails.
Query if the angle 'theta' is included in this arc.
The angle.
true if it succeeds, false if it fails.
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
Maximum 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
Assignment operator.
The right hand side of the assignment operation.
A deep copy of this object.
Constructor.
The center x coordinate.
The center y coordinate.
The radius.
The start angle.
The sweep angle.
The color.
Constructor.
The segment.
The color.
Copy constructor.
The other.
Default constructor.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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 an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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 an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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 TipDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets TipDiameter property in the specified units.
true to get value in metric.
TheTipDiameter property.
Gets or sets the tip diameter (for use on lens form tools)
Gets or sets the taper angle (for use on tapered form tools)
Sets UpperRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets UpperRadius property in the specified units.
true to get value in metric.
TheUpperRadius property.
Gets or sets the upper radius (for use on tapered form tools)
Sets PrimaryCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets PrimaryCornerRadius property in the specified units.
true to get value in metric.
ThePrimaryCornerRadius property.
Gets or sets the primary corner radius.
Sets ProfileRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets ProfileRadius property in the specified units.
true to get value in metric.
TheProfileRadius property.
Profile Radius
Sets BarrelLength property in the specified units.
value to set.
true to specify value is in metric.
Gets BarrelLength property in the specified units.
true to get value in metric.
TheBarrelLength property.
Barrel Length
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Constructor.
Implementation of the main Mastercam tool system.
Creates a new TlAssemblyPtr from the given tool.
The tool.
A TlAssemblyPtr.
Creates a new TlAssemblyPtr based on the tool type and metric flag.
Type of the tool.
true if this object is metric.
A TlAssemblyPtr.
Factory service class providing functionality for creating instances of class TlAssembly.
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.
Tool Material Code
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Custom Option 7 Timing
Custom Option 7 State
Custom Option 6 Timing
Custom Option 6 State
Custom Option 5 Timing
Custom Option 5 State
Custom Option 4 Timing
Custom Option 4 State
Custom Option 3 Timing
Custom Option 3 State
Custom Option 2 Timing
Custom Option 2 State
Custom Option 1 Timing
Custom Option 1 State
Tool Timing
Tool State
Mist Timing
Mist State
Flood Timing
Flood State
Old Style Flag
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the get default cutting side operation.
A TlCuttingSide.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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 an ANSI cross section string position.
The TCHAR to process.
The ANSI cross section string position.
Gets the ANSI cross section string.
The ANSI cross section string.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the get default cutting side operation.
A TlCuttingSide.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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.
Declaration of private deserialization implementation class.
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 holder identifier list.
The holder identifier list.
Resets all guids.
true if it succeeds, false if it fails.
Builds the composite.
Retrieve a specific holder node pointer.
The identifier.
The root.
.
Gets the holder tree root node.
The holder tree root node.
The Assembly tool projection was changed, so modify the main holder's CScalar to account for that.
The insertion.
true if it succeeds, false if it fails.
Adds a holder segment.
Width of the top.
Width of the bottom.
The height.
true if it succeeds, false if it fails.
Gets const holder node list. Order is from closest to the tool to the root.
The holder node list.
Replaces an existing child holder.
Zero-based index of the children holders. The root is index 0.
The new child.
true if it succeeds, false if it fails.
Adds a holder.
Identifier for the parent.
If non-null, the holder.
If non-null, the transform.
If non-null, the transform.
If non-null, the transform.
The scalar.
true if it succeeds, false if it fails.
Main Holder Identifier
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
The children.
The scalar.
The c transformation.
The u transformation.
The m transformation.
The holder.
Determines if the holder inserts over its child.
true if it inserts over its child, false if it inserts into its child.
Sets an insertion.
The insertion.
Gets the insertion.
The insertion.
Gets the children of this item.
The children.
Sets a holder.
The holder.
Gets the holder.
The holder.
Adds a child.
The child.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
[in,out] The item.
Default constructor.
Array indexer operator.
Zero-based index of the.
The indexed value.
Parameterized constructor.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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.
Array indexer operator.
Parameterized constructor.
The double to process.
The double to process.
The double to process.
The double to process.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Merges composite node profiles.
The current profile.
The current node.
The insertion.
A merged profile.
Merges the given holder profiles.
The root holder profile.
The child holder profile.
The insertion depth.
A merged profile.
Query if this object is linear.
The tree.
true if linear, false if not.
Retrieves all holder nodes.
The root.
List of nodes.
Retrieves all const holder nodes.
The root.
List of nodes.
Retrieves all holder i ds.
The root.
[out] List of identifiers.
Inserts a holder node.
The identifier.
[in] The root.
[in] The child.
true if it succeeds, false if it fails.
Sets a holder identifiers.
The root.
The map of old IDs to new IDs.
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.
Resets all guids.
true if it succeeds, false if it fails.
Builds the composite.
Retrieve a specific holder node pointer.
The identifier.
The root.
.
Gets the holder tree root node.
The holder tree root node.
The Assembly tool projection was changed, so modify the main holder's CScalar to account for that.
The insertion.
true if it succeeds, false if it fails.
Adds a holder segment.
Width of the top.
Width of the bottom.
The height.
true if it succeeds, false if it fails.
Gets holder node list. Order is from closest to the tool to the root.
The holder node list.
Gets const holder node list. Order is from closest to the tool to the root.
The holder node list.
Gets the holder identifier list.
The holder identifier list.
Replaces an existing child holder.
Zero-based index of the children holders. The root is index 0.
The new child.
true if it succeeds, false if it fails.
Adds a holder.
Identifier for the parent.
The holder.
The transform.
The transform.
The transform.
The scalar.
true if it succeeds, false if it fails.
Assignment operator.
The const TlHolderComposite to process.
A shallow copy of this object.
Query if this object is linear.
true if linear, false if not.
Copy constructor.
The TlHolderComposite to process.
Parameterized constructor.
true if this object is metric.
Executes the clone operation.
A TlObjectPtr.
The children.
The transformation.
The transformation.
The transformation.
The holder.
MFC Serialization function.
The archive.
Determines if the holder inserts over its child.
true if it inserts over its child, false if it inserts into its child.
Gets the children of this item.
The children.
Gets a flag indicating whether this holder tree node is metric or not.
true if the node is in metric.
Sets a holder.
The holder.
Gets the holder.
The holder.
Adds a child.
The child.
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 const TlHolderTreeNode & to process.
A shallow copy of this object.
Adds a child.
The child.
Clone Function.
A pointer to a copy of this object.
Parameterized constructor.
The holder.
The transformation.
The transformation.
The transformation.
The scalar.
Move constructor.
The right hand side.
Parameterized constructor.
The node.
The matrix.
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.
Array indexer operator.
Zero-based index of the.
The indexed value.
Parameterized constructor.
The matrix.
Parameterized constructor.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
Default constructor.
The data.
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.
Array indexer operator.
Zero-based index of the.
The indexed value.
Parameterized constructor.
The double to process.
The double to process.
The double to process.
The double to process.
Default constructor.
Marshals managed TlProfileArcSegment::Arc2D type to native a_2d type.
The arc of type Arc2D.
A arc of type a_2d.
Marshals native a_2d type to managed TlProfileArcSegment::Arc2D type.
The arc of type a_2d.
A arc of type Arc2D.
Marshals managed TlProfileLineSegment::Line2d type to native l_2d type.
The line of type Line2D.
A line of type l_2d.
Marshals native l_2d type to managed TlProfileLineSegment::Line2d type.
The line of type l_2d.
A line of type Line2D.
Marshals managed TlProfileSegment::Point2D type to native p_2d type.
The point of type Point2D.
A point of type p_2d.
Marshals native p_2d type to managed TlProfileSegment::Point2D type.
The point of type p_2d.
A point of type Point2D.
Query if this object is convex.
true if convex, false if not.
Query if arc sweeps completely between 270 degrees to 90 degrees (inclusive).
true if it succeeds, false if it fails.
Query if the angle 'theta' is included in this arc.
The angle.
true if it succeeds, false if it fails.
Constructor.
The center x coordinate.
The center y coordinate.
The radius.
The start angle.
The sweep angle.
The color.
Constructor.
The segment.
The color.
Arc
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Arc2D.
Constructor.
The endpoint 1 x coordinate.
The endpoint 1 y coordinate.
The endpoint 2 x coordinate.
The endpoint 2 y coordinate.
The color.
Line
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Line2D.
Spring cuts
Sets Pulloff property in the specified units.
value to set.
true to specify value is in metric.
Gets Pulloff property in the specified units.
true to get value in metric.
ThePulloff property.
Pulloff
Sets FinishAllowance property in the specified units.
value to set.
true to specify value is in metric.
Gets FinishAllowance property in the specified units.
true to get value in metric.
TheFinishAllowance property.
Finish allowance
Sets LastDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets LastDepthOfCut property in the specified units.
true to get value in metric.
TheLastDepthOfCut property.
Last depth of cut
Sets FirstDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets FirstDepthOfCut property in the specified units.
true to get value in metric.
TheFirstDepthOfCut property.
First depth of cut
Sets FlatWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets FlatWidth property in the specified units.
true to get value in metric.
TheFlatWidth property.
Flat width
Sets LaydownHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets LaydownHeight property in the specified units.
true to get value in metric.
TheLaydownHeight property.
Laydown height
Sets NotchPointLocation property in the specified units.
value to set.
true to specify value is in metric.
Gets NotchPointLocation property in the specified units.
true to get value in metric.
TheNotchPointLocation property.
Notch point location
Sets MaxThreadPitch property in the specified units.
value to set.
true to specify value is in metric.
Gets MaxThreadPitch property in the specified units.
true to get value in metric.
TheMaxThreadPitch property.
Gets or sets the Maximum Thread Pitch
Sets MinThreadPitch property in the specified units.
value to set.
true to specify value is in metric.
Gets MinThreadPitch property in the specified units.
true to get value in metric.
TheMinThreadPitch property.
Gets or sets the Minimum Thread Pitch
Is external thread
Thread type (UNIFIED, ACME, BUTTRESS, ETC.)
Insert style (TOP NOTCH, LAYDOWN)
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the get default cutting side operation.
A TlCuttingSide.
Gets the ANSI string.
The ANSI string.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
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 or sets the Dwell measured in seconds.
Gets or sets the Chip Break measured as a percentage of the tool diameter.
Gets or sets the Peck Clear measured as a percentage.
Gets or sets the Peck 2 measured as a percentage of the tool diameter.
Gets or sets the Peck 1 measured as a percentage of the tool diameter.
Canned Cycle Type
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Tests if Coolant reference property is set.
true if Coolant is set, false if not.
Gets or sets the tool coolant parameters.
Sets PlungeRate property in the specified units.
value to set.
true to specify value is in metric.
Gets PlungeRate property in the specified units.
true to get value in metric.
ThePlungeRate property.
Plunge Rate
Sets RetractRate property in the specified units.
value to set.
true to specify value is in metric.
Gets RetractRate property in the specified units.
true to get value in metric.
TheRetractRate property.
Retract Rate
Sets FeedRate property in the specified units.
value to set.
true to specify value is in metric.
Gets FeedRate property in the specified units.
true to get value in metric.
TheFeedRate property.
Feed Rate
Metric Flag
Spindle Speed
Material FPT Adjust
Material SFM Adjust
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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 PilotLength property in the specified units.
value to set.
true to specify value is in metric.
Gets PilotLength property in the specified units.
true to get value in metric.
ThePilotLength property.
Pilot Length
Sets PilotDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets PilotDiameter property in the specified units.
true to get value in metric.
ThePilotDiameter property.
Pilot Diameter
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Utility function that compresses the database.
true if it succeeds, false if it fails.
Display the browse for tool library to save or append dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional, defaults to NULL) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to save dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional, defaults to NULL) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to open dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional, defaults to NULL) HWnd of the parent.
true if it succeeds, false if it fails.
Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an
updated library path.
true if the library has been migrated, false if not.
Query if the library is updated.
The library must be opened to perform this functionality.
true if updated, false if not.
Query if this object is open.
true if open, false if not.
Gets the full library path including the filename.
The library must be opened to perform this functionality.
The library path.
Gets library filename including the extension.
The library must be opened to perform this functionality.
The library filename.
Gets the library data version.
The library must be opened to perform this functionality.
The library data version.
Gets the library schema version.
The library must be opened to perform this functionality.
The library schema version.
Performs a batch of changes including the addition of items, deletion of items, and the update of items.
The items to add.
The items to delete.
The items to update.
true if it succeeds, false if it fails.
Deletes all items in the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlCutParams from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGrades from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlManufacturers from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlMaterials from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolderLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlInserts from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolders from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolMills from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlTools from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlAssemblies from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes the given items from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given item from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Updates the given items in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given item in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlCutParams from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGrades from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlManufacturers from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlMaterials from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlInserts from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolMills from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlAssemblies from the library.
The library must be opened to perform this functionality.
The resulting items.
(Optional, defaults to false) True to locally convert mill tools that are not in an assembly into
an assembly with a default holder, and include them in the resulting items.
true if it succeeds, false if it fails.
Adds the contents of a TlMgr to the library.
The library must be opened to perform this functionality.
The TlMgr to add.
true if it succeeds, false if it fails.
Adds a vector of TlObjectPtrs to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a TlObject item to the library.
The library must be opened to perform this functionality.
The item to add.
true if it succeeds, false if it fails.
Creates new library at the specified libraryPath.
The library file path, including the filename.
true if it succeeds, false if it fails.
Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location
as the opened library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Updates the library.
The library must be opened to perform this functionality.
(Optional, defaults to true) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Closes the library.
Opens the specified library. Will create the library if it does not exist.
Full pathname of the library file to open.
true to update the library to the latest schema version.
(Optional, defaults to true) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Finalizer.
Destructor.
Default Constructor.
The tool library system class.
Makes holder segments from profile.
The profile.
A vector of TlHolderSegment.
Makes profile from holder segments.
The holder segments.
A TlProfilePtr.
Gets the length.
The length.
Gets the height.
The height.
Query if this object is default holder.
true if default holder, false if not.
Deletes all segments.
true if it succeeds, false if it fails.
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.
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.
Accessory items for this holder
Lower Connection Type
Lower Connection Size
Upper Connection Type
Upper Connection Size
Holder Type
Library Name
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
A tl holder segment.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Gets the profile parameters.
The profile parameters.
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.
Copy constructor taking a base class type. This is used to sepparate the CounterBore tool type from it's
previous home (TlToolDrill) to this class definition.
The const TlToolDrill to process.
Default Constructor.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Gets the profile parameters.
The profile parameters.
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.
Copy constructor taking a base class type. This is used to sepparate the CenterDrill tool type from it's
previous home (TlToolDrill) to this class definition.
The const TlToolDrill to process.
Default Constructor.
Declaration of private deserialization implementation class.
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.
Gets the profile parameters.
The profile parameters.
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 the radius type.
Type of the radius.
Gets the corner type.
The corner type.
Sets a thread count.
Number of threads.
Gets the thread count.
The thread count.
Sets a corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Sets an operation tool information.
The information.
Default constructor.
Declaration of private deserialization implementation class.
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.
Gets the profile parameters.
The profile parameters.
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 holemaking operation parameters.
The holemaking operation parameters.
Default constructor.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Gets the profile parameters.
The profile parameters.
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 corner radius.
The value.
Gets corner radius.
The corner radius.
Sets operation tool information.
The information.
Gets operation tool information.
The operation tool information.
Default constructor.
Declaration of private deserialization implementation class.
Executes the is similar operation.
The sp other.
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.
Gets the profile parameters.
The profile parameters.
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.
Copy constructor taking a base class type. This is used to sepparate the SlotMill tool type from it's
previous home (TlToolEndmill) to this class definition.
The const TlToolEndmill to process.
Default Constructor.
Declaration of private deserialization implementation class.
Executes the is similar operation.
The sp other.
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.
Gets the profile parameters.
The profile parameters.
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 milling operation parameters.
The milling operation parameters.
Sets the radius type.
The radius.
Sets the radius type.
The radius.
Sets the radius type.
The radius.
Gets the radius type.
The radius type.
Sets the corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Gets operation tool information.
The operation tool information.
Default constructor.
Utility function that compresses the database.
true if it succeeds, false if it fails.
Display the browse for tool library to save or append dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to save dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to open dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an
updated library path.
true if the library has been migrated, false if not.
Query if the library is updated.
The library must be opened to perform this functionality.
true if updated, false if not.
Query if this object is open.
true if open, false if not.
Gets the full library path including the filename.
The library must be opened to perform this functionality.
The library path.
Gets library filename including the extension.
The library must be opened to perform this functionality.
The library filename.
Gets the library data version.
The library must be opened to perform this functionality.
The library data version.
Gets the library schema version.
The library must be opened to perform this functionality.
The library schema version.
Performs a batch of changes including the addition of items, deletion of items, and the update of items.
The items to add.
The items to delete.
The items to update.
true if it succeeds, false if it fails.
Deletes all items in the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlCutParams from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGrades from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlManufacturers from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlMaterials from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolderLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlInserts from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolders from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolMills from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlTools from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlAssemblies from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes the given items from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given item from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Updates the given items in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given item in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlCutParams from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGrades from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlManufacturers from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlMaterials from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlInserts from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolMills from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlAssemblies from the library.
The library must be opened to perform this functionality.
The resulting items.
True to locally convert mill tools that are not in an assembly into
an assembly with a default holder, and include them in the resulting items.
true if it succeeds, false if it fails.
Adds the contents of a TlMgr to the library.
The library must be opened to perform this functionality.
The TlMgr to add.
true if it succeeds, false if it fails.
Adds a vector of TlObjectPtrs to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a TlObject item to the library.
The library must be opened to perform this functionality.
The item to add.
true if it succeeds, false if it fails.
Gets filter string.
true if wire machine.
The filter string.
Creates new library at the specified libraryPath.
The library file path, including the filename.
true if it succeeds, false if it fails.
Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location
as the opened library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Updates the library.
The library must be opened to perform this functionality.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Closes the library.
Opens the specified library. Will create the library if it does not exist.
Full pathname of the library file to open.
true to update the library to the latest schema version.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Destructor.
Constructor.
The tool library system class.
Sets a manufacturer.
The manufacturer.
true if it succeeds, false if it fails.
Sets a work material.
The material.
true if it succeeds, false if it fails.
Sets an operation type.
The type.
true if it succeeds, false if it fails.
Sets a tool type.
The type.
true if it succeeds, false if it fails.
Sets a grade.
The grade.
true if it succeeds, false if it fails.
Gets or sets the machine name.
Manufacturer
Work Material
Op Type
Tool Type
Grade
Cut Source
Cut Quality
Proven Flag
Metric Flag
Feed Factor
Maximum FPT
Minimum FPT
Maximum Cut Speed
Minimum Cut Speed
Tool Life Minutes
Tool Life Linear
Gets or sets the finish axial depth of cut.
Gets or sets the finish radial depth of cut.
Gets or sets the rough axial depth of cut.
Gets or sets the rough radial depth of cut.
Surface Finish
FPT
Cut Speed
Maximum Diameter
Minimum Diameter
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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 a manufacturer.
The manufacturer.
true if it succeeds, false if it fails.
Sets a work material.
The material.
true if it succeeds, false if it fails.
Sets an operation type.
The type.
true if it succeeds, false if it fails.
Sets a tool type.
The type.
true if it succeeds, false if it fails.
Sets a grade.
The grade.
true if it succeeds, false if it fails.
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.
Static Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Sets an operation group identifier.
The group.
true if it succeeds, false if it fails.
Sets an operation group identifier.
The group.
true if it succeeds, false if it fails.
Gets the operation group identifier.
The operation group identifier.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Group the parent belongs to.
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 operation group identifier.
The group.
true if it succeeds, false if it fails.
Sets an operation group identifier.
The group.
true if it succeeds, false if it fails.
Gets the operation group identifier.
The operation group identifier.
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.
Sets the radius type.
The radius.
Radius Type
Sets Shift property in the specified units.
value to set.
true to specify value is in metric.
Gets Shift property in the specified units.
true to get value in metric.
TheShift property.
Shift
Taper Angle
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets drilling operation parameters.
The drilling operation parameters.
Sets PrimaryCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets PrimaryCornerRadius property in the specified units.
true to get value in metric.
ThePrimaryCornerRadius property.
Gets or sets the primary corner radius.
Shoulder Angle
Tip Angle
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Declaration of private deserialization implementation class.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Gets the profile parameters.
The profile parameters.
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 the radius type.
Type of the radius.
true if it succeeds, false if it fails.
Gets the corner type.
The corner type.
Gets operation tool information.
The operation tool information.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Declaration of private deserialization implementation class.
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.
Gets the profile parameters.
The profile parameters.
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 drilling operation parameters.
The drilling operation parameters.
Sets a corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Gets operation tool information.
The operation tool information.
Default constructor.
Sets Width property in the specified units.
value to set.
true to specify value is in metric.
Gets Width property in the specified units.
true to get value in metric.
TheWidth property.
Gets or sets the width of the connection.
Sets Thickness property in the specified units.
value to set.
true to specify value is in metric.
Gets Thickness property in the specified units.
true to get value in metric.
TheThickness property.
Gets or sets the thickness of the connection.
Gets or sets a value indicating whether the connection is round or square.
Gets or sets the locator for the connection defined relative to the parent origin.
Gets or sets the connection size string.
Gets or sets the connection type string.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Manufacturer Identifier
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Removes the type group described by group.
The group.
true if it succeeds, false if it fails.
Adds a tool type identifier.
The group.
true if it succeeds, false if it fails.
Adds a tool type identifier.
The group.
true if it succeeds, false if it fails.
Gets the tool type ids.
The tool type ids.
Image Path
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
The tool type ids.
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 the type group described by group.
The group.
true if it succeeds, false if it fails.
Adds a tool type identifier.
The group.
true if it succeeds, false if it fails.
Adds a tool type identifier.
The group.
true if it succeeds, false if it fails.
Gets the tool type ids.
The tool type ids.
Image File Path
Group Identifier
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Taper Size
Taper Style
Maximum RPM
Maximum Workpiece Weight
Sets CompressionLength property in the specified units.
value to set.
true to specify value is in metric.
Gets CompressionLength property in the specified units.
true to get value in metric.
TheCompressionLength property.
Compression Length
Point Style
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Is this object is custom
Is vertically mounted tool
Is left hand tool
Is round shank
Side cutting edge angle
End cutting edge angle
Sets ChamferHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ChamferHeight property in the specified units.
true to get value in metric.
TheChamferHeight property.
Height of the chamfer
Sets ChamferWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ChamferWidth property in the specified units.
true to get value in metric.
TheChamferWidth property.
Width of the chamfer
Sets HeadWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets HeadWidth property in the specified units.
true to get value in metric.
TheHeadWidth property.
Width of the head
Sets HeadLength property in the specified units.
value to set.
true to specify value is in metric.
Gets HeadLength property in the specified units.
true to get value in metric.
TheHeadLength property.
Length of the head
Sets ShankHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ShankHeight property in the specified units.
true to get value in metric.
TheShankHeight property.
Height of the shank
Sets ShankWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ShankWidth property in the specified units.
true to get value in metric.
TheShankWidth property.
Width of the shank
Sets Width property in the specified units.
value to set.
true to specify value is in metric.
Gets Width property in the specified units.
true to get value in metric.
TheWidth property.
Width
Sets Length property in the specified units.
value to set.
true to specify value is in metric.
Gets Length property in the specified units.
true to get value in metric.
TheLength property.
Length
Insert shapes
ANSI shape code
Type
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
A deserialization implementation.
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 object is complete profile.
true if complete profile, false if not or if empty profile.
Completes the profile.
true if it succeeds, false if it fails.
Half the profile.
true if it succeeds, false if it fails.
Default constructor.
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.
Adds an operation type identifier.
The group.
true if it succeeds, false if it fails.
Adds an operation type identifier.
The group.
true if it succeeds, false if it fails.
Gets the operation type ids.
The operation type ids.
Cycle
Dwell time
Sets Retract property in the specified units.
value to set.
true to specify value is in metric.
Gets Retract property in the specified units.
true to get value in metric.
TheRetract property.
Retract
Sets PeckClr property in the specified units.
value to set.
true to specify value is in metric.
Gets PeckClr property in the specified units.
true to get value in metric.
ThePeckClr property.
Peck clearance
Sets Peck2 property in the specified units.
value to set.
true to specify value is in metric.
Gets Peck2 property in the specified units.
true to get value in metric.
ThePeck2 property.
Peck 2
Sets Peck1 property in the specified units.
value to set.
true to specify value is in metric.
Gets Peck1 property in the specified units.
true to get value in metric.
ThePeck1 property.
Peck 1
Tap type
Sets Pitch property in the specified units.
value to set.
true to specify value is in metric.
Gets Pitch property in the specified units.
true to get value in metric.
ThePitch property.
Pitch
Shoulder angle
Sets TipLength property in the specified units.
value to set.
true to specify value is in metric.
Gets TipLength property in the specified units.
true to get value in metric.
TheTipLength property.
Tip length
Sets TipDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets TipDiameter property in the specified units.
true to get value in metric.
TheTipDiameter property.
Tip diameter
Sets ChamferHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ChamferHeight property in the specified units.
true to get value in metric.
TheChamferHeight property.
Chamfer height
Flutes count
Flute angle
Sets CutLength property in the specified units.
value to set.
true to specify value is in metric.
Gets CutLength property in the specified units.
true to get value in metric.
TheCutLength property.
Cut length
Sets FluteLength property in the specified units.
value to set.
true to specify value is in metric.
Gets FluteLength property in the specified units.
true to get value in metric.
TheFluteLength property.
Flute length
Tip angle
Sets ShankDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets ShankDiameter property in the specified units.
true to get value in metric.
TheShankDiameter property.
Shank diameter
Sets Diameter property in the specified units.
value to set.
true to specify value is in metric.
Gets Diameter property in the specified units.
true to get value in metric.
TheDiameter property.
Diameter
Drill type
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
The handedness of the insert
Gets or sets a value indicating whether the insert is a 3d insert
Is custom
Material name
Index material
Index thickness
Index corner radius
Width of the index
Mastercam old-style lathe insert compatibility data
Tests if Grade reference property is set.
true if Grade is set, false if not.
The insert grade.
Sets Thickness property in the specified units.
value to set.
true to specify value is in metric.
Gets Thickness property in the specified units.
true to get value in metric.
TheThickness property.
Thickness
Sets CornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets CornerRadius property in the specified units.
true to get value in metric.
TheCornerRadius property.
Corner radius
Sets Width property in the specified units.
value to set.
true to specify value is in metric.
Gets Width property in the specified units.
true to get value in metric.
TheWidth property.
Width
Sets Length property in the specified units.
value to set.
true to specify value is in metric.
Gets Length property in the specified units.
true to get value in metric.
TheLength property.
Length
Sets ICDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets ICDiameter property in the specified units.
true to get value in metric.
TheICDiameter property.
IC diameter
ANSI shape code
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the get default cutting side operation.
A TlCuttingSide.
Gets the ANSI string.
The ANSI string.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
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.
Import from stored profile.
The stored profile to validate, sort, and scale.
The scale to apply to the profile.
A TlProfileResult.
Batch import from layer.
The levels to import from.
The scales to apply to the profiles.
A vector of TlProfileResult objects.
Import from layer.
The level to import from.
The scale to apply to the profile.
A TlProfileResult.
Batch import from file.
The filenames.
The scales to apply to the profiles.
The isTool flags, true if importing for a tool, false for a holder.
Full pathnames of the resulting transmit files, if any are created.
A vector of TlProfileResult objects.
Batch import from file.
The filenames.
The scales.
The isTool flags, true if importing for a tool, false for a holder.
A vector of TlProfileResult objects.
Import profile from file.
Filename of the file.
The scale to apply to the profile.
true if importing for a tool, false for a holder.
Full pathname of the resulting transmit file, if one is created.
A TlProfileResult.
Import profile from file.
Filename of the file.
The scale.
true if importing for a tool, false for a holder.
A TlProfileResult.
Implementation of the main Mastercam tool system.
Encapsulates the result of the construction of a profile.
Values that represent possible profile calculation result states.
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.
Determines if we have any line segments on the Y axis.
true if it succeeds, false if it fails.
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.
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.
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, defaults to false) 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 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
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, defaults to false) 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, defaults to false) 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.
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
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Reverses the segment.
Trim at x coordinate value.
The x coordinate.
(Optional, defaults to true) true to keep lower segment.
A TlProfileSegmentPtr.
Trim at y coordinate value.
The y value to trim to.
(Optional, defaults to true) 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.
Values that represent the various possible transformations for a segment.
Color
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Point2D.
Sort and validate profile result.
The result.
Default private constructor.
Import from stored profile.
The stored profile to validate, sort, and scale.
The scale to apply to the profile.
A TlProfileResult.
Batch import from layer.
The levels to import from.
The scales to apply to the profiles.
A vector of TlProfileResult objects.
Import from a SW Sketch (only in MCforSW).
Name of the SW sketch.
The scale to apply to the profile.
A TlProfileResult.
Import from layer.
The level to import from.
The scale to apply to the profile.
A TlProfileResult.
Batch import from file.
The filenames.
The scales to apply to the profiles.
The isTool flags where true means importing a tool and false is importing a holder.
Full pathnames of the resulting transmit files, if any are created.
A vector of TlProfileResult objects.
Batch import from file.
The filenames.
The scales.
The isTool flags where true means importing a tool and false is importing a holder.
A vector of TlProfileResult objects.
Import profile from file.
Filename of the file.
The scale to apply to the profile.
true if importing a tool, false if a holder.
Full pathname of the resulting transmit file, if one is created.
A TlProfileResult.
Import profile from file.
Filename of the file.
The scale.
true if importing a tool, false if a holder.
A TlProfileResult.
The tool profile importer.
Encapsulates the result of the construction of a profile.
Values that represent possible profile calculation result states.
Density
Hardness Value
Hardness Unit
ISO Value
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Sets a commercial name.
The name.
true if it succeeds, false if it fails.
Gets the commercial name.
The commercial name.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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 an ISO value.
The value.
true if it succeeds, false if it fails.
Removes the old material hardness described by scale.
The scale.
true if it succeeds, false if it fails.
Removes the old material group described by group.
The group.
true if it succeeds, false if it fails.
Sets an old hardness value.
The scale.
The value.
true if it succeeds, false if it fails.
Sets an old material group identifier.
The group.
The identifier.
true if it succeeds, false if it fails.
Gets the hardness for scale.
The scale.
The hardness for scale.
Gets program radius.
The program radius.
Gets tapered height.
The tapered height.
Lower Taper Angle
Relief Taper Angle
Upper Taper Angle
Sets UpperRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets UpperRadius property in the specified units.
true to get value in metric.
TheUpperRadius property.
Upper Radius
Sets LowerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets LowerRadius property in the specified units.
true to get value in metric.
TheLowerRadius property.
Lower Radius
Sets TipDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets TipDiameter property in the specified units.
true to get value in metric.
TheTipDiameter property.
Tip Diameter
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Convenience only - No backing field on TlToolMill
The corner radius.
Convenience only - No backing field
The corner radius.
Adjust length for stickout.
The stickout.
Sets a canned text coolant.
The coolant.
Gets the canned text coolant data
The canned text coolant data
Sets the mastercam type of this tool.
The value.
Returns the mastercam type of this tool.
The Mastercam type of this tool.
Returns a list of the IDs of the op type this tool
supports
The list of op type IDs support by this tool
Adds a supported tool type ID for this tool.
true if the ID was successfully set, false otherwise
Adds a supported op type ID for this tool.
true if the ID was successfully set, false otherwise
Gets or sets whether the tool is an accelerated finishing tool.
Gets or sets the legacy aggregate head data used with aggregates and block drills.
Tests if ToolGrade reference property is set.
true if ToolGrade is set, false if not.
Gets or sets the grade of this tool.
Tests if ToolMaterial reference property is set.
true if ToolMaterial is set, false if not.
Gets or sets the material of this tool.
Tests if OpParams reference property is set.
true if OpParams is set, false if not.
Gets or sets the operation parameters stored with this tool.
Sets LegacyHolderDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets LegacyHolderDiameter property in the specified units.
true to get value in metric.
TheLegacyHolderDiameter property.
Legacy Holder Diameter
Sets LegacyHolderLength property in the specified units.
value to set.
true to specify value is in metric.
Gets LegacyHolderLength property in the specified units.
true to get value in metric.
TheLegacyHolderLength property.
Legacy Holder Length
Sets TruePhysicalLength property in the specified units.
value to set.
true to specify value is in metric.
Gets TruePhysicalLength property in the specified units.
true to get value in metric.
TheTruePhysicalLength property.
True Physical Length
Adjusted for Stickout Flag
Scalable Flag
Variable Pitch Flag
Aggregate Flag
FBM Flag
Helix Angle
Helix Type
Flute Count
Length Offset Number
Diameter Offset Number
Chuck
Spindle Direction
Sets RequiredPilotDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets RequiredPilotDiameter property in the specified units.
true to get value in metric.
TheRequiredPilotDiameter property.
Required Pilot Diameter
Sets NeckDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets NeckDiameter property in the specified units.
true to get value in metric.
TheNeckDiameter property.
Neck Diameter
Sets TaperLength property in the specified units.
value to set.
true to specify value is in metric.
Gets TaperLength property in the specified units.
true to get value in metric.
TheTaperLength property.
Taper Length
Shank Type
Sets ShoulderDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets ShoulderDiameter property in the specified units.
true to get value in metric.
TheShoulderDiameter property.
Shoulder Diameter
Sets ArborDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets ArborDiameter property in the specified units.
true to get value in metric.
TheArborDiameter property.
Arbor Diameter
Sets OverallDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets OverallDiameter property in the specified units.
true to get value in metric.
TheOverallDiameter property.
Overall Diameter
Sets CuttingDepth property in the specified units.
value to set.
true to specify value is in metric.
Gets CuttingDepth property in the specified units.
true to get value in metric.
TheCuttingDepth property.
Cutting Depth
Sets ShoulderLength property in the specified units.
value to set.
true to specify value is in metric.
Gets ShoulderLength property in the specified units.
true to get value in metric.
TheShoulderLength property.
Shoulder Length
Sets OverallLength property in the specified units.
value to set.
true to specify value is in metric.
Gets OverallLength property in the specified units.
true to get value in metric.
TheOverallLength property.
Overall Length
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
tool_attr_head.
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.
Gets the profile parameters.
The profile parameters.
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 corner radius.
The corner radius.
Gets program radius.
The program radius.
Gets tapered height.
The tapered height.
Sets operation tool information.
The information.
Gets operation tool information.
The operation tool information.
Default constructor.
Gets native tl object pointer.
The native tl object pointer.
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 the objects.
nullptr if it fails, else the 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.
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.
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.
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.
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 id of the item to search for.
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 id of the item to search for.
[out] The assembly.
true if the item is found, 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, defaults to false)
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.
Assignment operator.
The right hand side.
A shallow copy of this object.
Finalizer.
Destructor.
Copies the given TlMgr.
The other tlMgr.
true if it succeeds, false if it fails.
Copy Constructor. Creates a copy tool manager.
The other tlMgr.
Default Constructor. Creates a copy tool manager.
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.
Allocate appropriate managed object based referencing native object.
The underlying native object.
nullptr if it fails, else a managed wrapper object.
Gets or sets whether the tool requires a tool locator
Gets or sets the machine side connection type
Gets or sets the holder direction.
Canned Text Coolant
Retract Force
Retract Output
Retract Type
Retract Select
Approach Force
Approach Output
Approach Type
Approach Select
Spindle Speed
Slow Feed Rate type
Sets SlowFeedRate property in the specified units.
value to set.
true to specify value is in metric.
Gets SlowFeedRate property in the specified units.
true to get value in metric.
TheSlowFeedRate property.
Slow Feed Rate
Fast Feed Rate Type
Sets FastFeedRate property in the specified units.
value to set.
true to specify value is in metric.
Gets FastFeedRate property in the specified units.
true to get value in metric.
TheFastFeedRate property.
Fast Feed Rate
Coolant Status
Sets ToolHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ToolHeight property in the specified units.
true to get value in metric.
TheToolHeight property.
Tool Height
Sets ToolWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ToolWidth property in the specified units.
true to get value in metric.
TheToolWidth property.
Tool Width
Tool Rake Angle
Tool Clearance Angle
Percentage Material CSS
Percentage Material Feed
Turret Angle
Sets ToolCenterY property in the specified units.
value to set.
true to specify value is in metric.
Gets ToolCenterY property in the specified units.
true to get value in metric.
TheToolCenterY property.
Tool Center Y Coordinate
Sets ToolCenterX property in the specified units.
value to set.
true to specify value is in metric.
Gets ToolCenterX property in the specified units.
true to get value in metric.
TheToolCenterX property.
Tool Center X Coordinate
Sets HomePositionY property in the specified units.
value to set.
true to specify value is in metric.
Gets HomePositionY property in the specified units.
true to get value in metric.
TheHomePositionY property.
Home Position Y Coordinate
Sets HomePositionX property in the specified units.
value to set.
true to specify value is in metric.
Gets HomePositionX property in the specified units.
true to get value in metric.
TheHomePositionX property.
Home Position X Coordinate
Tool Back Offset Number
Tool Offset Number
Component Type
Active Turret
Active Spindle
Spindle Direction
Spindle Speed CSS
Inverted Tool Flag
Selection Flag
Tests if MainHolder reference property is set.
true if MainHolder is set, false if not.
Gets or sets the main holder of this lathe tool assembly.
Tests if MainInsert reference property is set.
true if MainInsert is set, false if not.
Gets or sets the main insert of this lathe tool assembly.
Main Holder Identifier
Main Insert Identifier
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Determines if the other tool is similar enough to be considered a duplciate.
The other.
(Optional, defaults to NULL_ID) identifier for the machine group to aid in the comparison.
(Optional, defaults to 0) 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 the tool Display Type.
The tool Display type
Sets a display type.
The type.
Accessory Collection
Geometry Level
Display Type
Is Custom
Manufacturer's Tool Code
Machine Group
Tool Station
Tool Number
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Gets the Assembly Gauge length
The Gauge Length
Gets the Tool Projection
The tool projection
Gets the total length of all holders
The total length of holders
Sets tool number.
The tool number.
Group the machine belongs to.
Sets as default assembly.
The value.
true if it succeeds, false if it fails.
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.
Collection of graphics files associated to this item.
Accessory items for this tool assembly
Tests if MainHolder reference property is set.
true if MainHolder is set, false if not.
Main holder on this tool assembly.
Tests if MainTool reference property is set.
true if MainTool is set, false if not.
Main tool on this tool assembly.
Maximum Ramp Angle.
Sets ComponentCScalar property in the specified units.
value to set.
true to specify value is in metric.
Gets ComponentCScalar property in the specified units.
true to get value in metric.
TheComponentCScalar property.
Component C Scalar .
Sets Stickout property in the specified units.
value to set.
true to specify value is in metric.
Gets Stickout property in the specified units.
true to get value in metric.
TheStickout property.
Stickout.
Metric Flag.
Main Holder Identifier.
Main Tool Identifier.
Default Assembly Flag.
Length Offset Number.
Diameter Offset Number.
Machine Group.
Tool Number.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets or sets the vector of accessory items associated to this item.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Gets the operation groups.
The operation groups.
Gets or sets the collection of graphics files associated to this item.
Tests if WorkpieceSideConnection reference property is set.
true if WorkpieceSideConnection is set, false if not.
Gets or sets the workpiece side connection on this tool assembly component.
Gets or sets the machine side connection of this tool assembly component.
Tests if Manufacturer reference property is set.
true if Manufacturer is set, false if not.
Gets or sets the manufacturer of this tool assembly component.
Tests if StoredProfile reference property is set.
true if StoredProfile is set, false if not.
Gets or sets the stored profile of this tool assembly component.
Sets GaugeLength property in the specified units.
value to set.
true to specify value is in metric.
Gets GaugeLength property in the specified units.
true to get value in metric.
TheGaugeLength property.
Gauge Length
Sets GaugeDiameter property in the specified units.
value to set.
true to specify value is in metric.
Gets GaugeDiameter property in the specified units.
true to get value in metric.
TheGaugeDiameter property.
Gauge Diameter
Tool type Identifier
Material Identifier
Catalog item flag
Thru Coolant
Metric Flag
Quantity On Hand
Tests if ModelFile reference property is set.
true if ModelFile is set, false if not.
Main Model File
Geometry File
Location
Catalog Identifier
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Sets the translation portion of the locator, scaling the input value if necessary.
The value.
True if the value is in metric.
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 or sets the translation portion of the locator.
Gets or sets a value indicating whether this locator is in Metric units or not.
Gets or sets the rotation portion of the locator.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Adds an operation type identifier.
The group.
true if it succeeds, false if it fails.
Adds an operation type identifier.
The group.
true if it succeeds, false if it fails.
Gets the operation type ids.
The operation type ids.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets or sets the vector of graphics files associated to this item.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
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.
Gets or sets the graphics file format.
Gets or sets graphics file data in byte form.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Constructor.
Pointer to underlying native object to wrap.
Default Constructor.
Gets smart pointer to native TlObject.
The smart pointer to native TlObject (always non-null).
Resets all identifiers associated to this object.
Sets an identifier.
The identifier.
true if it succeeds, false if it fails.
Gets the identifier.
The identifier.
Inequality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are not considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Finaliser.
Destructor.
Gets or sets the slot index of this object.
Gets or sets the description of this object.
Gets or sets the name of this object.
Assignment operator.
[in,out] The right hand side.
A shallow copy of this object.
Makes a deep copy of this object.
nullptr if it fails, else a copy of this object.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor.
Pointer to managed object to reference.
Default Constructor.
Constructor.
Pointer to underlying native object to wrap.
Given two old lathe tools, compare them to find if they are equal.
The first lathe tool.
The second lathe tool.
true if the lathe tools are equal.
Given two old inserts, compare them to find if they are equal.
The first insert.
The second insert.
true if the inserts are equal.
Given two old holders, compare them to find if they are equal.
The first holder.
The second holder.
true if the holders are equal.
Given two double, returns true if they are equal within tolerance.
The first double to compare.
The double to compare against "first".
true if the attributes match within tol, false otherwise.
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.
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.
Macro for allocating an ent structure instead of having it on the stack.
Checks if the working measurement system is NOT english.
True if the system is not english; false if it is.
Checks if the working measurement system is NOT english.
True if the system is not english; false if it is.
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.
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. 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.
Class representing a transformation matrix column for use with composite mill tool holders.
Declares the TransformationMatrix type and its shared_ptr/unique_ptr aliases.
Class representing a transformation matrix for use with composite mill tool holders.
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.
Class representing a custom user-defined operation type.
Declares the TlOpGroup type and its shared_ptr/unique_ptr aliases.
Class representing a custom user-defined operation group.
Declares the TlHolemakingOpParams type and its shared_ptr/unique_ptr aliases.
Class defining Drilling Tool Operation Parameters.
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.
Class representing an arc segment on a 2D profile.
Declares the TlProfileLineSegment type and its shared_ptr/unique_ptr aliases.
Class representing a line segment on a 2D profile.
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.
Class representing a Lathe Live Center.
Declares the TlHolderLatheTurning type and its shared_ptr/unique_ptr aliases.
Tl holder lathe turning.
Declares the TlHolderLatheThreading type and its shared_ptr/unique_ptr aliases.
Tl holder lathe threading class.
Declares the TlHolderLatheGrooving type and its shared_ptr/unique_ptr aliases.
Tl holder lathe grooving class.
Declares the TlHolderLatheDrill type and its shared_ptr/unique_ptr aliases.
Tl holder lathe drill class.
Declares the TlHolderLatheBoring type and its shared_ptr/unique_ptr aliases.
Tl holder lathe boring class.
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.
Tl insert turning boring class.
Declares the TlInsertThreading type and its shared_ptr/unique_ptr aliases.
Tl insert threading class.
Declares the TlInsertLatheDrill type and its shared_ptr/unique_ptr aliases.
Tl insert lathe drill class.
Declares the TlInsertGrooving type and its shared_ptr/unique_ptr aliases.
Tl insert grooving class.
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.
Class representing a cutting parameter.
Declares the TlToolType type and its shared_ptr/unique_ptr aliases.
Class representing a custom user-defined tool type.
Declares the TlToolGroup type and its shared_ptr/unique_ptr aliases.
Class representing a custom user-defined tool group.
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.
Class representing a workpiece material within the Mastercam tool system.
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.
Class representing a node within the tree of holders that make up a composite mill tool holder.
Declares the TlHolderComposite type and its shared_ptr/unique_ptr aliases.
Class representing a composite mill tool holder.
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.
Class representing barrel mill tools.
Declares the TlToolFeedMill type and its shared_ptr/unique_ptr aliases.
Class representing high feed milling tools
Declares the TlToolThreading type and its shared_ptr/unique_ptr aliases.
Class representing tools that have threading characteristics.
Declares the TlToolReamer type and its shared_ptr/unique_ptr aliases.
Class representing reamer tools.
Declares the TlToolLatheCustom type and its shared_ptr/unique_ptr aliases.
Class representing custom lathe tools.
Declares the TlToolLatheISO type and its shared_ptr/unique_ptr aliases.
Class representing isometric lathe tools.
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.
Class represnting tool types that contain similar end milling type parameters.
Declares the TlToolSlotMill type and its shared_ptr/unique_ptr aliases.
Class representing slot mill tools.
Declares the TlToolDrill type and its shared_ptr/unique_ptr aliases.
Class representing tools that contain common holemaking parameters.
Declares the TlToolCenterDrill type and its shared_ptr/unique_ptr aliases.
Class representing center drill tools.
Declares the TlToolCounterBore type and its shared_ptr/unique_ptr aliases.
Class representing counter bore tools.
Declares the TlToolBoring type and its shared_ptr/unique_ptr aliases.
Class representing fine boring tools.
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 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.