"ToolNetApi"
Executes the save geometry to Mastercam file application used to save mill assembly, tool, and/or holder
boundaries and solids to a Mastercam part file.
The items to save.
If non-null, the parent window.
Executes the save geometry to Mastercam file application used to save tool, holder, and/or insert
boundaries and solids to a Mastercam part file.
The items to save.
If non-null, the parent window.
Exports the model data for the given lathe tool assembly.
The lathe tool assembly.
(Optional) Export model parameters.
The collection of exported models.
Exports the model data for the given lathe tool.
The lathe tool.
(Optional) Export model parameters.
The collection of exported models.
Exports the model data for the given lathe 3D tool assembly.
The lathe 3D tool assembly.
(Optional) Export model parameters.
The collection of exported models. #include
Exports the model data for the tool assembly associated to the operation identified by the given
operation id. If there is an acceptable tool associated to the operation specified by the given id,
the solid model geometry representing the tool assembly will be exported as a tesselated triangle
data set. The model data and cutting/noncutting state of this data will be filled out into the given
result vector.
Identifier for the operation.
True to include operation adjustments in the final orientation of
the tool.
Export model parameters.
The collection of exported models.
The non cutting model (Holder).
The cutting model (Insert).
An exported model data.
The model triangle array.
The model vertex array.
The third triangle index.
The second triangle index.
The first triangle index.
Triangle data structure for mesh model.
The normal.
The vertex.
Triangle Vertex data structure.
Triangle data structure for mesh model.
The view matrix to apply to models before they are exported.
The surface tolerance for non-cutting portions of the tool.
The surface tolerance for cutting portions of the tool.
Parameters specifying the tessellation and transformation of the exported models.
Export the boundaries and solids defined for the given lathe tool onto the specified level. Solids will
only be stored on the specified level if the tool is a 3d tool assembly.
The tool assembly.
The level.
True if it succeeds, false if it fails.
Exports the boundaries and solid models stored within the specified lathe tool onto the specified level.
The tool assembly.
The level.
True if it succeeds, false if it fails.
Exports the profiles and solids specified by the mill holder onto the specified level.
The mill holder.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the profiles and solids specified by the mill tool onto the specified level.
The mill tool.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the profiles and solids specified by the mill assembly onto the specified level.
The mill assembly.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the solids specified by the mill holder onto the specified level.
The mill holder.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the solids specified by the mill tool onto the specified level.
The mill tool.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the solids specified by the mill assembly onto the specified level.
The mill assembly.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified lathe tool onto the specified level. Only valid for
3d tool assemblies.
The tool assembly.
The level.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified 3d tool assembly onto the specified level.
The tool assembly.
The level.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified turn holder onto the specified level.
The holder.
The level.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified insert onto the specified level.
The insert.
The level.
True if it succeeds, false if it fails.
Exports boundaries and solids to the specified mcam file. Boundaries will be exported for all tools, but
solids will only be exported for 3d tool assemblies.
The tool assemblies.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the boundaries and solids for the specified 3d tool assembly out to the specified Mastercam part
file. Only the specific boundaries for the specified view of the tool assembly will be exported.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the boundaries and solids for the specified 3d tool assembly view out to the specified Mastercam
part file. Only the specific boundaries for the specified view of the tool assembly will be exported.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the solids for all 3d tools in the given collection of lathe tool assemblies to the specified
Mastercam part file.
The tool assemblies.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill holder out to the specified Mastercam part file.
The mill holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill tool out to the specified Mastercam part file.
The mill tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill assembly out to the specified Mastercam part file.
The mill tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified 3d tool assembly out to the specified Mastercam part file.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified turn holder out to the specified Mastercam part file.
The holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified insert out to the specified Mastercam part file.
The insert.
Full pathname of the file.
True if it succeeds, false if it fails.
Imports solids for the specified turn holder from the specified step file into the holder.
The holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Imports solids for the specified insert from the specified step file into the insert.
The insert.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tool out to the specified level in the
current Mastercam part file.
The lathe tool.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified specified 3D tool assembly lathe
definition out to the specified level in the current Mastercam part file.
The 3D lathe tool assembly view of a specific lathe cutting definition.
The level.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified 2D lathe tool out to the specified level
in the current Mastercam part file.
The 2D lathe tool.
The level.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tools out to the specified
Mastercam part file.
The lathe tools.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tool out to the specified
Mastercam part file.
The lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified 3D tool assembly lathe definition out to
the specified Mastercam part file.
The 3D lathe tool assembly view of a specific lathe cutting definition.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries fort he specified 2D lathe tool out to the specified
Mastercam part file.
The 2D lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Import the cutting and non-cutting boundaries from the specified level into the given 2D custom lathe
tool. Boundaries are expected to follow the defined 2D lathe custom tool boundary rules.
The 2D custom lathe tool.
The level.
True if it succeeds, false if it fails.
Import the cutting and non-cutting boundaries from the specified file. Only valid for Mastercam file
formats. Boundaries are expected to follow the defined 2D lathe custom tool boundary rules.
The 2D custom lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the profile of the given item to the specified level in the current part file.
The mill tool to export the profile geometry of.
The level to export to.
The level parameters.
True to link to the level. Linking to the level will mean that the tool will retrieve
the most up to date version of the profile from the specified level when accessed.
True if it succeeds, false if it fails.
Exports the profile of the given holder onto the specified level in the current part file.
The holder to export the profile geometry of.
The level to export to.
The level parameters.
True if it succeeds, false if it fails.
Exports the profile of the given assembly onto the specified level in the current part file.
The mill assembly.
The level.
The level parameters.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool from the specified Mastercam level into the tool with the
option to link to the level and scale the profile based on tool diameter.
The mill tool to import the profile geometry into.
The level to import from.
True to link to the level. Linking to the level will mean that the
tool will retrieve the most up to date version of the profile from the
specified level when accessed.
True to scale the profile to the tool diameter. Supports legacy
profile formats that needed to be scaled such that the radius of the profile
was defined at 1 unit (in/mm).
True if it succeeds, false if it fails.
Imports the profile for the given mill tool holder from the specified Mastercam level into the holder as
its stored profile.
The holder.
The level to import from.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool from the specified file into the tool.
Geometry in Mastercam file formats is expected to be on the primary level in the Mastercam format, which
is starting at the origin and forming a half-profile in quadrant one that can be revolved around the
Y-axis. Geometry in DXF file formats is expected to conform to the ISO-13399 format, with boundaries
on CUT and NOCUT levels. STEP file formats should have the solid going down the Z-axis.
The mill tool.
Full pathname of the file to import from.
True if link to file if able. Linking to the file will mean that
the tool will retrieve the most up to date version of the profile from the
specified file when accessed. Only supported for Mastercam file formats.
True to scale the profile to the tool diameter. Supports legacy
profile formats that needed to be scaled such that the radius of the profile
was defined at 1 unit (in/mm). Only supported for Mastercam file formats.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool holder from the specified file into the holder as its stored
profile.
Geometry in Mastercam file formats is expected to be on the primary level in the Mastercam format, which
is starting at the origin and forming a half-profile in quadrant one that can be revolved around the
Y-axis. Geometry in DXF file formats is expected to conform to the ISO-13399 format, with a boundary
on the NOCUT level. STEP file formats should have the solid going down the Z-axis.
The holder.
Full pathname of the file to import from.
True if it succeeds, false if it fails.
The level parameters.
Functionality for tool/holder/insert geometry import export.
Executes the save geometry to Mastercam file application used to save mill assembly, tool, and/or holder
boundaries and solids to a Mastercam part file.
The items to save.
(Optional) If non-null, the parent window.
Executes the save geometry to Mastercam file application used to save tool, holder, and/or insert
boundaries and solids to a Mastercam part file.
The items to save.
(Optional) If non-null, the parent window.
Exports the model data for the given lathe tool assembly.
The lathe tool assembly.
(Optional) Export model parameters.
The collection of exported models.
Exports the model data for the given lathe tool.
The lathe tool.
(Optional) Export model parameters.
The collection of exported models.
Exports the model data for the given lathe 3D tool assembly.
The lathe 3D tool assembly.
(Optional) Export model parameters.
The collection of exported models.
Exports the model data for the tool assembly associated to the operation identified by the given
operation id. If there is an acceptable tool associated to the operation specified by the given id,
the solid model geometry representing the tool assembly will be exported as a tesselated triangle
data set. The model data and cutting/noncutting state of this data will be filled out into the given
result vector.
Identifier for the operation.
(Optional) True to include operation adjustments in the final orientation of
the tool.
(Optional) Export model parameters.
The collection of exported models.
An exported model data.
Triangle data structure for mesh model.
Triangle Vertex data structure.
Triangle data structure for mesh model.
Parameters specifying the tessellation and transformation of the exported models.
Export the boundaries and solids defined for the given lathe tool onto the specified level.
The tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the boundaries and solid models stored within the specified lathe tool onto the specified level.
The tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Export the mill holder profile and solids on to the specified level.
The mill holder.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Export the live center profile and solids on to the specified level.
The live center.
The level.
(Optional) A variable-length parameters list containing parameters.
True if it succeeds, false if it fails.
Export the mill tool profile and solids on to the specified level.
The mill tool.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Export the mill assembly profile and solids on to the specified level.
The mill tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Export the live center solids on to the specified level.
The live center.
[in,out] The level.
A variable-length parameters list containing parameters.
True if it succeeds, false if it fails.
Export the mill holder solids on to the specified level.
The mill holder.
The level.
(Optional) The level parameters.
(Optional) The projection to move the holder.
True if it succeeds, false if it fails.
Export the mill tool solids on to the specified level.
The mill tool.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Export the mill assembly solids on to the specified level.
The mill tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified lathe tool onto the specified level.
The tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified lathe tool onto the specified level.
The tool assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified holder assembly onto the specified level.
The holder assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified turn holder onto the specified level.
The adaptive item.
The level.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified turn holder onto the specified level.
The holder.
The level.
True if it succeeds, false if it fails.
Exports the solid models stored within the specified insert onto the specified level.
The insert.
The level.
True if it succeeds, false if it fails.
Exports boundaries and solids to the specified mcam file. Boundaries will be exported for all tools, but
solids will only be exported for 3d tool assemblies.
The tool assemblies.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the boundaries and solids for the specified 3d tool assembly out to the specified Mastercam part
file. Only the specific boundaries for the specified view of the tool assembly will be exported.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the boundaries and solids for the specified 3d tool assembly view out to the specified Mastercam
part file. Only the specific boundaries for the specified view of the tool assembly will be exported.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the solids for all 3d tools in the given collection of lathe tool assemblies to the specified
Mastercam part file.
The tool assemblies.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill holder out to the specified Mastercam part file.
The mill holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill tool out to the specified Mastercam part file.
The mill tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified mill assembly out to the specified Mastercam part file.
The assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified 3d tool assembly out to the specified Mastercam part file.
The tool assembly.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified turn holder out to the specified Mastercam part file.
The holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Export the solids for the specified insert out to the specified Mastercam part file.
The insert.
Full pathname of the file.
True if it succeeds, false if it fails.
Imports solids for the specified turn holder from the specified step file into the holder.
The holder.
Full pathname of the file.
True if it succeeds, false if it fails.
Imports solids for the specified insert from the specified step file into the insert.
The insert.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports all cutting and non-cutting boundaries for the specified lathe tool out to the specified level or levels
depending on the options in params, for the current Mastercam part file.
The tool assembly.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tool out to the specified level in
the current Mastercam part file.
The lathe tool.
The level.
The level parameters.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified specified 3D tool assembly lathe definition out
to the specified level in the current Mastercam part file.
The 3D lathe tool assembly view of a specific lathe cutting definition.
The level.
(Optional) True to for save to level.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified 2D lathe tool out to the specified level
in the current Mastercam part file.
The 2D lathe tool.
The level.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tools out to the specified
Mastercam part file.
The lathe tools.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified lathe tool out to the specified
Mastercam part file.
The lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries for the specified 3D tool assembly lathe definition out to
the specified Mastercam part file.
The 3D lathe tool assembly view of a specific lathe cutting definition.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the cutting and non-cutting boundaries fort he specified 2D lathe tool out to the specified
Mastercam part file.
The 2D lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Import the cutting and non-cutting boundaries from the specified level into the given 2D custom lathe
tool. Boundaries are expected to follow the defined 2D lathe custom tool boundary rules.
The 2D custom lathe tool.
The level.
True if it succeeds, false if it fails.
Import the cutting and non-cutting boundaries from the specified file. Only valid for Mastercam file
formats. Boundaries are expected to follow the defined 2D lathe custom tool boundary rules.
The 2D custom lathe tool.
Full pathname of the file.
True if it succeeds, false if it fails.
Exports the profile of the given item to the specified level in the current part file.
The mill tool to export the profile geometry of.
The level to export to.
(Optional) The level parameters.
(Optional) True to link to the level. Linking to the level will mean that the tool
will retrieve the most up to date version of the profile from the specified level
when accessed.
True if it succeeds, false if it fails.
Exports the profile of the given holder onto the specified level in the current part file.
The holder to export the profile geometry of.
The level to export to.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Exports the profile of the given live center onto the specified level in the current part file.
The live center.
The level.
A variable-length parameters list containing parameters.
True if it succeeds, false if it fails.
Export the mill assembly profile to the designated level.
The mill assembly.
The level.
(Optional) The level parameters.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool from the specified Mastercam level into the tool with the
option to link to the level and scale the profile based on tool diameter.
The mill tool to import the profile geometry into.
The level to import from.
(Optional) True to link to the level. Linking to the level will mean that the
tool will retrieve the most up to date version of the profile from the
specified level when accessed.
(Optional) True to scale the profile to the tool diameter. Supports legacy
profile formats that needed to be scaled such that the radius of the profile
was defined at 1 unit (in/mm).
True if it succeeds, false if it fails.
Imports the profile for the given mill tool holder from the specified Mastercam level into the holder as
its stored profile.
The holder.
The level to import from.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool from the specified file into the tool.
Geometry in Mastercam file formats is expected to be on the primary level in the Mastercam format, which
is starting at the origin and forming a half-profile in quadrant one that can be revolved around the
Y-axis. Geometry in DXF file formats is expected to conform to the ISO-13399 format, with boundaries
on CUT and NOCUT levels. STEP file formats should have the solid going down the Z-axis.
The mill tool.
Full pathname of the file to import from.
(Optional) True if link to file if able. Linking to the file will mean that
the tool will retrieve the most up to date version of the profile from the
specified file when accessed. Only supported for Mastercam file formats.
(Optional) True to scale the profile to the tool diameter. Supports legacy
profile formats that needed to be scaled such that the radius of the profile
was defined at 1 unit (in/mm). Only supported for Mastercam file formats.
True if it succeeds, false if it fails.
Imports the profile for the given mill tool holder from the specified file into the holder as its stored
profile.
Geometry in Mastercam file formats is expected to be on the primary level in the Mastercam format, which
is starting at the origin and forming a half-profile in quadrant one that can be revolved around the
Y-axis. Geometry in DXF file formats is expected to conform to the ISO-13399 format, with a boundary
on the NOCUT level. STEP file formats should have the solid going down the Z-axis.
The holder.
Full pathname of the file to import from.
True if it succeeds, false if it fails.
The level parameters.
Creates a new instance of the IToolDataImporter interface specialized for importing Generic Tool Catalog
(Classification) packages containing tooling data in the ISO13399 standardized format.
The new GTC package importer.
Static class with the functionality to create IToolDataImporter instances to import Generic GTC packages.
This class cannot be inherited.
Creates a new instance of the IToolDataImporter interface specialized for importing Generic Tool
Catalog (Classification) packages containing tooling data in the ISO13399 standardized format.
The new GTC package importer.
No return value marshaller.
The native instance.
Nullptr if it fails, else a NoReturnValuePlaceholder^.
Generates an image for the specified 2D lathe tool instance and stores it on the instance.
The 2D lathe tool instance.
True if it succeeds, false if it fails.
Generates an image for the specified insert instance and stores it on the instance.
The insert instance.
True if it succeeds, false if it fails.
Generates an image for the specified turn holder instance and stores it on the instance.
The turn holder instance.
True if it succeeds, false if it fails.
Generates an image for the specified adaptive item instance and stores it on the instance.
The adaptive item instance.
True if it succeeds, false if it fails.
Generates an image for the specified 3D holder assembly instance and stores it on the instance.
The holder assembly instance.
True if it succeeds, false if it fails.
Generates images for each of the lathe tool definitions on the specified 3D tool assembly instance and
stores them on the instance.
The lathe definition view.
True if it succeeds, false if it fails.
Generates an image for the specified lathe tool instance and stores it on the instance.
The lathe tool instance.
True if it succeeds, false if it fails.
Generates an image for the specified lathe tool definition view of a 3D tool assembly instance and then
stores it on the instance.
The lathe definition view.
True if it succeeds, false if it fails.
Utility methods for generating and updating images on tool class instances.
Generates an image for the specified 2D lathe tool instance and stores it on the instance.
The 2D lathe tool instance.
True if it succeeds, false if it fails.
Generates an image for the specified insert instance and stores it on the instance.
The insert instance.
True if it succeeds, false if it fails.
Generates an image for the specified turn holder instance and stores it on the instance.
The turn holder instance.
True if it succeeds, false if it fails.
Generates an image for the specified adaptive item instance and stores it on the instance.
The adaptive item instance.
True if it succeeds, false if it fails.
Generates an image for the specified 3D holder assembly instance and stores it on the instance.
The holder assembly instance.
True if it succeeds, false if it fails.
Generates images for each of the lathe tool definitions on the specified 3D tool assembly instance and
stores them on the instance.
The lathe definition view.
True if it succeeds, false if it fails.
Generates an image for the specified lathe tool instance and stores it on the instance.
The lathe tool instance.
True if it succeeds, false if it fails.
Generates an image for the specified lathe tool definition view of a 3D tool assembly instance and then
stores it on the instance.
The lathe definition view.
True if it succeeds, false if it fails.
Calculates the profile.
The profile calculation parameters.
The profile result.
Service class providing functionality to build parametric profiles for milling and holemaking tools.
The arbor diameter.
The neck diameter.
Length of the taper.
The shoulder diameter.
The shoulder length.
Type of the shank.
The thread pitch.
The thread shape.
The pilot diameter.
Length of the pilot..
The secondary corner chamfer length.
Length of the primary tip chamfer.
The shoulder angle or relief angle.
The secondary corner chamfer angle.
The tip angle.
The secondary corner radius.
The primary corner radius.
The secondary (usually tip) diameter..
The primary compensation diameter.
The flute length.
The overall length of the tool.
Primary corner type of the tool.
Mastercam tool type value.
The standard tolerance to be used for calculations.
The NC tolerance to be used for calculations.
true if this tool is metric.
Profile Entity (line/arc) color.
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.
Resets the identifiers.
Creates a description of this tool.
The new description.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the IMTool interface.
Gets or sets the diameter offset number.
Gets or sets the length offset number.
Interface for a mill tool.
Fill parameters in the provided LATHETOOL instance using the contained tool data.
Options for controlling the operation.
Makes a deep copy of this object.
A copy of this object.
Deletes the solids.
Clears the highlighting.
Highlight solids for component item.
Identifier for the component item.
Sets the visibility (blanked) state of the solids not associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids.
True to show, false to hide.
Calculates the extents of the solids marked as cutting or non cutting.
The minimum extents.
The maximum extents.
True to measure the cutting solids, false for non cutting.
Calculates the extents of the solids.
The minimum extents.
The maximum extents.
Transform the solids by the specified transformation matrix.
The matrix.
Searches for the component item identifier mapped to the specified solid entity pointer.
The eptr.
The component item id mapped to the specified eptr if found, nullptr if not.
Gets the view that the solids were built in.
A reference to a const CM::Transform3D.
Gets the view that the solids were built in.
A reference to a const CM::Transform3D.
Gets the solids that are not for the specified component item.
Identifier for the component item.
The solids not marked as for the specified component item.
Gets the solids for the specified component item.
Identifier for the component item.
The solids marked as for the specified component item.
Gets the solids.
Gets all solids defined in this set of data.
Adds the specified solid eptr as associated to the specified component item.
The eptr.
Identifier for the component item.
True if the specified component is a cutting component, false if not.
An interface representing the solids data of a designer applet.
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.
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 repository.
Saves the library data to the file it was loaded from.
True if it succeeds, false if it fails.
Gets the repository of data.
A reference to an IRepository templated to the library data type.
Constructor.
The native instance to adapt.
Saves the library data to the file it was loaded from.
True if it succeeds, false if it fails.
Gets the repository of data.
A reference to an IRepository templated to the library data type.
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.
The profile scale.
True if the destination tool or holder is metric.
Full pathname of the DLL file.
The install directory.
Filename of the file.
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 access to the database TlMgr instance.
The database TlMgr instance.
Gets the single instance of the ITempCatalogDataManager interface.
The single instance of the ITempCatalogDataManager interface.
Gets access to the cutting data importer manager.
The ICuttingDataImporterManager interface instance.
Gets access to the tool data importer manager.
The IToolDataImporterManager interface instance.
Gets an instance of the IToolSystem interface.
The IToolSystem interface instance.
Type providing access to the tool system services.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
The view transform used to present the solids in a user friendly way.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
The view transform used to present the solids in a user friendly way.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
The view transform used to present the solids in a user friendly way.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Optimizes the solids defined as part of the given adaptive item.
The adaptive item to optimize the solids of.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given turn holder.
The turn holder to optimize the solids of.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given insert.
The insert to optimize the solids of.
True if it succeeds, false if it fails.
Utility methods for shared functionality related to tool solids.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
(Optional) The view transform used to present the solids in a user friendly way.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
(Optional) The view transform used to present the solids in a user friendly way.
Runs the Solid Repair Small Faces App on the solids defined for the given item.
The item to repair the small faces of.
(Optional) The view transform used to present the solids in a user friendly way.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given item and checks for faults on the result.
The item to optimize the solids of.
Output flag to convey if the optimized solids have faults.
True if it succeeds, false if it fails.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Checks for faults on the solids defined as part of the given item.
The item to optimize the solids of.
True if faults are found, false if not.
Optimizes the solids defined as part of the given adaptive item.
The adaptive item to optimize the solids of.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given turn holder.
The turn holder to optimize the solids of.
True if it succeeds, false if it fails.
Optimizes the solids defined as part of the given insert.
The insert to optimize the solids of.
True if it succeeds, false if it fails.
Gets the lathe toolpath parameters if valid for the current operation context.
Gets the mill toolpath parameters if valid for the current operation context.
Gets the grooving parameters.
Gets the threading parameters.
Gets the facing parameters.
Gets the turning parameters.
Gets or sets the backoff percentage of stepover.
Gets or sets the stock clearance.
Gets or sets the finishing depth of cut.
Gets or sets the roughing depth of cut.
Constructor.
If non-null, the native instance.
Grooving parameters.
Gets or sets the spring cut count.
Gets or sets the anticipated pulloff distance.
Gets or sets the finish pass allowance.
Gets or sets the last depth of cut.
Gets or sets the first depth of cut.
Constructor.
If non-null, the native instance.
Threading parameters.
Gets or sets the overcut amount.
Gets or sets the retract amount.
Gets or sets the finishing depth of cut.
Gets or sets the roughing depth of cut.
Constructor.
If non-null, the native instance.
Facing parameters.
Gets or sets the overlap amount.
Gets or sets the depth of cut.
Constructor.
If non-null, the native instance.
Turning parameters.
Gets or sets the units the plunge rate is defined in.
Gets or sets the plunge rate.
Gets or sets the units the feed rate is defined in.
Gets or sets the feed rate.
Gets or sets the spindle speed maximum.
Gets or sets the units the spindle speed is defined in.
Gets or sets the spindle speed.
Constructor.
If non-null, the native instance.
Lathe toolpath parameters.
Gets or sets the radial depth of cut if applicable for the current toolpath.
Gets or sets the axial depth of cut if applicable for the current toolpath.
Gets or sets the feed rate.
Gets or sets the spindle speed.
Constructor.
If non-null, the native instance.
Milling toolpath parameters.
Constructor.
If non-null, the native instance.
Toolpath parameter data.
Gets the lathe toolpath parameters if valid for the current operation context.
Gets the mill toolpath parameters if valid for the current operation context.
Gets the grooving parameters.
Gets the threading parameters.
Gets the facing parameters.
Gets the turning parameters.
Gets or sets the backoff percentage of stepover.
Gets or sets the stock clearance.
Gets or sets the finishing depth of cut.
Gets or sets the roughing depth of cut.
Grooving parameters.
Gets or sets the spring cut count.
Gets or sets the anticipated pulloff distance.
Gets or sets the finish pass allowance.
Gets or sets the last depth of cut.
Gets or sets the first depth of cut.
Threading parameters.
Gets or sets the overcut amount.
Gets or sets the retract amount.
Gets or sets the finishing depth of cut.
Gets or sets the roughing depth of cut.
Facing parameters.
Gets or sets the overlap amount.
Gets or sets the depth of cut.
Turning parameters.
Gets or sets the units the plunge rate is defined in.
Gets or sets the plunge rate.
Gets or sets the units the feed rate is defined in.
Gets or sets the feed rate.
Gets or sets the spindle speed maximum.
Gets or sets the units the spindle speed is defined in.
Gets or sets the spindle speed.
Lathe toolpath parameters.
Gets or sets the radial depth of cut if applicable for the current toolpath.
Gets or sets the axial depth of cut if applicable for the current toolpath.
Gets or sets the feed rate.
Gets or sets the spindle speed.
Milling toolpath parameters.
Toolpath parameter data.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The IEditToolAssemblyToolApplet managed adapter implementation.
Gets the single instance of the IEditToolAssemblyToolAppletFactory interface instance.
The reference to the IEditToolAssemblyToolAppletFactory interface instance.
Parameters for configuring this applet.
An edit tool assembly tool applet.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The IEditToolAssemblyHolderApplet managed adapter implementation.
Gets the single instance of the IEditToolAssemblyHolderApplet::Factory interface instance.
The reference to the IEditToolAssemblyHolderApplet::Factory interface instance.
Parameters for configuring this applet.
An edit tool assembly holder applet.
Adds the specified tool assembly to the machine group.
The assembly to add.
Identifier for the machine group to mark the assembly with.
True if it succeeds, false if it fails.
Appends a "Copy Of" marker to the specified assembly's name based on the set of similar tool assemblies.
The assembly to update.
The similar assemblies.
Initializes the tool offsets and station based on the specified machine group's settings.
The assembly.
Identifier for the machine group.
Gives the given assembly the next open tool number.
The assembly.
Identifier for the machine group.
Converts the specified set of mill tools into a set of default tool assemblies.
The mill tools.
The tools converted into assemblies.
Gets the machine group tool list engine.
Constructor.
The native instance.
The engine for the add tools to machine group applet.
Adds the specified tool assembly to the machine group.
The assembly to add.
Identifier for the machine group to mark the assembly with.
True if it succeeds, false if it fails.
Appends a "Copy Of" marker to the specified assembly's name based on the set of similar tool assemblies.
The assembly to update.
The similar assemblies.
Initializes the tool offsets and station based on the specified machine group's settings.
The assembly.
Identifier for the machine group.
Gives the given assembly the next open tool number.
The assembly.
Identifier for the machine group.
Converts the specified set of mill tools into a set of default tool assemblies.
The mill tools.
The tools converted into assemblies.
Gets the machine group tool list engine.
The engine for the add tools to machine group applet.
Creates a new instance of the IAddToolsToGroupEngine interface.
The new IAddToolsToGroupEngine interface instance.
Adds the specified tool assembly to the machine group.
The assembly to add.
Identifier for the machine group to mark the assembly with.
True if it succeeds, false if it fails.
Appends a "Copy Of" marker to the specified assembly's name based on the set of similar tool assemblies.
The assembly to update.
The similar assemblies.
Initializes the tool offsets and station based on the specified machine group's settings.
The assembly.
Identifier for the machine group.
Gives the given assembly the next open tool number.
The assembly.
Identifier for the machine group.
Converts the specified set of mill tools into a set of default tool assemblies.
The mill tools.
The tools converted into assemblies.
Gets access to the machine group tool list engine.
The machine group tool list engine.
The engine for the add tools to machine group applet.
Updates the tip treatment for taps.
The tool instance.
True if the tap is a plug tap, false for a bottoming tap.
Loads from level.
The level.
[in,out] The tool instance.
True to overwrite, false to preserve the geometry.
The data that was read from the level.
Saves to level.
The level.
[in,out] The tool instance.
True if it succeeds, false if it fails.
Calculates the maximum cutting deviation between the parameterized and custom anti-collision profiles.
The tool instance.
True, with a double representing the maximum cutting deviation if an anti-collision model exists. False otherwise.
Transfer library tool parameters.
[in,out] The tool instance.
The library object.
True if it succeeds, false if it fails.
Generates a profile from file.
[in,out] The tool instance.
Full pathname of the file.
True to overwrite, false to preserve the geometry.
The profile from file.
Re-calculate the feeds and speeds for the tool.
The tool instance.
Updates the tool to be the specified standard size tool. The tools must be of the same major tool type.
The tool instance.
The standard size tool.
Break custom geometry associations.
The tool instance.
Drops the tool's custom geometry and updates the model.
The tool instance.
Re-generates the name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
Generates a name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
The generated name of the tool.
Updates the corner treatment on the specified tool instance.
The tool instance.
The updated tool corner treatment type.
Automatically adjust the shoulder taper dimensions on the specified tool.
The tool.
Updates the IsMetric state on the specified tool.
The tool instance.
True if setting the value to metric, false for US units.
Updates the shank type of the specified tool, defaulting key shank parameters based on the updated type.
The tool to change the shank type of.
Type of the updated shank type.
Executes the 'tool type changed' action.
The tool to change the type of.
The updated tool type to set the tool to.
Creates a tool instance set up for manipulating in the mill tool designer.
Options for controlling the operation.
The new tool instance.
Constructor.
If non-null, the native instance.
Constructor.
The sp native instance.
An applet engine.
Gets the applet engine.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The interface representing the MillToolDesigner applet.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
Gets the applet engine.
A reference to a const IAppletEngine.
Options for controlling the behavior of the mill tool designer when editing a tool.
Options for controlling the behavior of the mill tool designer when creating a tool.
Options for controlling the behavior of the mill tool designer.
The interface representing the MillToolDesigner applet.
Adds the specified component above the component with the specified identifier.
The assembly.
Identifier for the component.
The created component.
Determine if we can add component above the component with the specified identifier.
The assembly.
Identifier for the component on the assembly to add above.
True if we can add component above, false if not.
Deletes the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
Determine if we can delete the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
True if we can delete component, false if not.
Updates the assembly tool.
The assembly.
The tool.
Gets the assembly tool for edit.
The assembly.
The assembly tool for edit.
Updates the assembly holder.
The assembly.
The holder.
Gets assembly holder for edit.
The assembly.
Identifier for the holder.
The assembly holder for edit.
Creates a tool assembly instance set up for manipulating in the mill tool assembly designer.
Options for controlling the operation.
The new tool assembly instance.
Constructor.
The native instance.
Constructor.
The native instance.
An applet engine.
Gets the applet engine.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The interface representing the MillHolderDesigner applet.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
Gets the applet engine.
A reference to a const IAppletEngine.
An edit assembly holder parameters.
Options for controlling the behavior of the mill tool assembly designer when editing the assembly tool.
Options for controlling the behavior of the mill tool designer when editing a tool.
Options for controlling the behavior of the mill tool designer when creating a tool.
Options for controlling the behavior of the mill tool designer.
The interface representing the MillToolAssemblyDesigner applet.
Runs this applet.
The result of the applet's run.
Creates an applet instance.
If non-null, the engine.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new applet.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ComponentModelSelector::IApplet managed adapter implementation.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
A parameters.
An applet that imports a tooling profile from a level.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, the engine.
Nullptr if it fails, else an IApplet^.
Constructor.
The native instance.
The LatheCenterDesigner::IApplet managed adapter implementation.
The interface representing the Lathe Center Selector applet.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
The interface representing the Lathe Center Designer applet.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, the engine.
Nullptr if it fails, else an IApplet^.
Constructor.
The native instance.
The LatheCenterDesigner::IApplet managed adapter implementation.
The interface representing the Lathe Center Filter applet.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
The interface representing the Lathe Center Designer applet.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The LatheCenterDesigner::IApplet managed adapter implementation.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
The interface representing the Lathe Center Designer applet.
Runs this applet.
The result of the applet's run.
Creates an applet instance.
If non-null, the engine.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new applet.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ComponentModelSelector::IApplet managed adapter implementation.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
A parameters.
An applet that imports a tooling profile from a file.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal results.
If non-null, the results.
The native results.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ComponentModelSelector::IApplet managed adapter implementation.
Gets the single instance of the IApplet::Factory interface instance.
The reference to the IApplet::Factory interface instance.
A create machine group mill tool parameters.
A results.
An applet for selecting a component model.
Gets the applet engine.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Constructor.
The native instance.
The interface representing the MillHolderDesigner applet.
Gets the single instance of the IAppletFactory interface instance.
The reference to the IAppletFactory interface instance.
Gets the applet engine.
A reference to a const IAppletEngine.
Options for controlling the behavior of the mill holder designer when editing a holder.
Options for controlling the behavior of the mill holder designer when creating a holder.
Common parameters for the mill holder designer.
The interface representing the MillHolderDesigner applet.
Parameters used to edit a mill holder instance.
Parameters used to create a mill holder instance.
Generates a name.
The holder instance.
The name.
Applies the profile to holder from level.
The holder instance.
The level.
A TlProfileResult.
Generates a profile from file.
The holder instance.
Full pathname of the file.
[in,out] The transmit file.
The profile from file.
Creates a holder instance set up for manipulating in the mill holder designer.
True to create a metric instance, false to create a U.S. units instance.
The new holder instance.
Constructor.
The native instance.
Constructor.
The native instance.
An applet engine.
Generates a name.
The holder instance.
The name.
Applies the profile to holder from level.
The holder instance.
The level.
A TlProfileResult.
Generates a profile from file.
The holder instance.
Full pathname of the file.
[in,out] The transmit file.
The profile from file.
Creates a holder instance set up for manipulating in the mill holder designer.
True to create a metric instance, false to create a U.S. units instance.
The new holder instance.
An applet engine.
Sets the selected segment indices, changing the graphical display to indicate that the segments are
selected.
The segment indices.
Gets the zero-based index of the lathe center segment intersecting the specified cursor position.
The cursor position.
The intersecting segment index.
Hides the gauge cylinder.
Shows the gauge cylinder.
Cleans up the graphical display for the lathe center designer.
Rebuilds the gauge cylinder display used when focus is given to the gauge length field within the lathe
center designer.
Rebuilds the graphical display for the lathe center designer.
Constructor.
The native instance.
The graphical display for the lathe center designer applet.
Sets the selected segment indices, changing the graphical display to indicate that the segments are
selected.
The segment indices.
Gets the zero-based index of the lathe center segment intersecting the specified cursor position.
The cursor position.
The intersecting segment index.
Hides the gauge cylinder.
Shows the gauge cylinder.
Cleans up the graphical display for the lathe center designer.
Rebuilds the gauge cylinder display used when focus is given to the gauge length field within the lathe
center designer.
Rebuilds the graphical display for the lathe center designer.
The graphical display for the lathe center designer applet.
Creates a graphical representation of the "display tool" in the currently active machine group.
True to show the selected operation's tool (if there is only one selected operation),
false to use the user-specified display tool.
The new display tool or nullptr if no display tool has been specified.
Creates a new instance of the IGrToolAssembly interface using the given TlToolLathe.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given 3d Tool assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given LTool.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface based on the given mill tool slot identifier. If
the there is a mill tool assembly corresponding to the specified slot identifier, a graphics object
will be created. Otherwise, a nullptr will be returned.
Identifier for the mill tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface based on the given operation id. If the operation
corresponding to the given id has a mill tool, a mill tool assembly graphics object will be created.
If the operation corresponding to the given id has a 3D tool, a 3D tool assembly graphics object will
be created. Otherwise, a nullptr will be returned.
Identifier for the operation.
True to ignore tool angle when creating the tool. Default behavior is to pass
false.
An IGrToolAssembly instance.
Constructor.
The native instance.
The graphics tool assembly factory.
Creates a graphical representation of the "display tool" in the currently active machine group.
True to show the selected operation's tool (if there is only one selected operation),
false to use the user-specified display tool.
The new display tool or nullptr if no display tool has been specified.
Creates a new instance of the IGrToolAssembly interface using the given TlToolLathe.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given 3d Tool assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given LTool.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface using the given assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface based on the given mill tool slot identifier. If
the there is a mill tool assembly corresponding to the specified slot identifier, a graphics object
will be created. Otherwise, a nullptr will be returned.
Identifier for the mill tool assembly.
An IGrToolAssembly instance.
Creates a new instance of the IGrToolAssembly interface based on the given operation id. If the operation
corresponding to the given id has a mill tool, a mill tool assembly graphics object will be created.
If the operation corresponding to the given id has a 3D tool, a 3D tool assembly graphics object will
be created. Otherwise, a nullptr will be returned.
Identifier for the operation.
True to ignore tool angle when creating the tool. Default behavior is to pass
false.
An IGrToolAssembly instance.
The graphics tool assembly factory.
Cleanup clearance dimensions.
Draw clearance end angle dimension.
Information describing the designer.
Draw clearance side angle dimension.
Information describing the designer.
Draw clearance height dimension.
Information describing the designer.
Draw clearance width dimension.
Information describing the designer.
Cleanup cut plunge arrows.
Shows the cut plunge arrows.
Information describing the designer.
Cleans up the stock gnomon.
Draw a gnomon display providing visual context into what direction the tool will be cutting in.
Information describing the designer.
Cleans up the stock display.
Draw a stock display providing visual context into how the tool will be cutting.
Information describing the designer.
Cleanup cut plane direction graphic.
Draw cut plane direction graphic.
Information describing the designer.
Fits the graphics screen to the extents of the insert solid.
Identifier for the insert.
Fits the graphics screen to the extents of the tool solids.
Cleanup the clearance points.
Gets the clearance point data.
The clearance point data.
Builds the clearance point data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanup wireframe.
Transform the wireframe in the specified set of designer data after changes to the assembly also within
the designer data.
The designer data.
Gets the wireframe data.
A reference to a const IDesignerWireframeData.
Builds the wireframe data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleans up all graphics managed by this engine.
Transform the solids in the specified set of designer data after changes to the assembly also within the
designer data.
The designer data.
Gets the extents transform.
A reference to a Matrix3D.
Maximum solid extents.
A reference to a const CM::Vector3D.
Minimum solid extents.
A reference to a const CM::Vector3D.
Gets the view that the solids were built in.
A reference to a const Matrix3D.
Gets the solids data.
A reference to the IDesignerSolidsData.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
Gets cutting current world transform.
Information describing the designer.
The cutting current world transform.
Gets insert current world transform.
Information describing the designer.
The insert current world transform.
Constructor.
The native instance.
A tool designer insert and definition graphics engine.
Cleanup clearance dimensions.
Draw clearance end angle dimension.
Information describing the designer.
Draw clearance side angle dimension.
Information describing the designer.
Draw clearance height dimension.
Information describing the designer.
Draw clearance width dimension.
Information describing the designer.
Cleanup cut plunge arrows.
Shows the cut plunge arrows.
Information describing the designer.
Cleans up the stock gnomon.
Draw a gnomon display providing visual context into what direction the tool will be cutting in.
Information describing the designer.
Cleans up the stock display.
Draw a stock display providing visual context into how the tool will be cutting.
Information describing the designer.
Cleanup cut plane direction graphic.
Draw cut plane direction graphic.
Information describing the designer.
Fits the graphics screen to the extents of the insert solid.
Identifier for the insert.
Fits the graphics screen to the extents of the tool solids.
Cleanup the clearance points.
Gets the clearance point data.
The readonly clearance point data.
Builds the clearance point data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanup wireframe.
Transform the wireframe in the specified set of designer data after changes to the assembly also within
the designer data.
The designer data.
Gets the wireframe data.
A reference to a const IDesignerWireframeData.
Builds the wireframe data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleans up all graphics managed by this engine.
Transform the solids in the specified set of designer data after changes to the assembly also within the
designer data.
The designer data.
Gets the extents transform.
A reference to a Matrix3D.
Maximum solid extents.
A reference to a const CM::Vector3D.
Minimum solid extents.
A reference to a const CM::Vector3D.
Gets the view that the solids were built in.
A reference to a const Matrix3D.
Gets the solids data.
A reference to the IDesignerSolidsData.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
Gets cutting current world transform.
Information describing the designer.
The cutting current world transform.
Gets insert current world transform.
Information describing the designer.
The insert current world transform.
A tool designer insert and definition graphics engine.
Updates the component images as needed described by designerData.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
The solids built to represent the tool assembly.
Updates the boundaries and images after a definition was edited. Boundaries for the edited definition are
considered to be already up to date.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The edited definition.
The solids built to represent the tool assembly after changes have been made.
Updates the boundaries and images after changes.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The solids built to represent the tool assembly after changes have been made.
Updates the assembly planes after changes.
Information describing the designer.
List of states of the previous.
Collect the states of the specified tool assembly before any changes are made to the component tree.
The data containing the tool assembly.
A shared pointer instance of component states.
Constructor.
The native instance.
A forward declaration of a type containing the states of an insert and its relationship on the assembly.
Creates view of a copy of the designer data's tool assembly with a new cutting definition associated to
the insert with the specified identifier.
The designer data.
Identifier for the insert to associate the cutting definition onto.
The new tool assembly view with the new definition, or nullptr if the identifier is not valid.
Creates view of a copy of the designer data's tool assembly with a new insert and definition on the turn
holder with the specified identifier.
The designer data.
Identifier for the holder to add the insert onto.
The new view with the new insert and definition, or nullptr if the identifier is not valid.
Creates a new tool assembly.
The new new tool assembly.
Constructor.
The native instance.
A tool designer engine adapter.
Updates the component images as needed described by designerData.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
The solids built to represent the tool assembly.
Updates the boundaries and images after a definition was edited. Boundaries for the edited definition are
considered to be already up to date.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The edited definition.
The solids built to represent the tool assembly after changes have been made.
Updates the boundaries and images after changes.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The solids built to represent the tool assembly after changes have been made.
Updates the assembly planes after changes.
Information describing the designer.
List of states of the previous.
Collect the states of the specified tool assembly before any changes are made to the component tree.
The data containing the tool assembly.
A shared pointer instance of component states.
A forward declaration of a type containing the states of an insert and its relationship on the assembly.
Creates view of a copy of the designer data's tool assembly with a new cutting definition associated to
the insert with the specified identifier.
The designer data.
Identifier for the insert to associate the cutting definition onto.
The new tool assembly view with the new definition, or nullptr if the identifier is not valid.
Creates view of a copy of the designer data's tool assembly with a new insert and definition on the turn
holder with the specified identifier.
The designer data.
Identifier for the holder to add the insert onto.
The new view with the new insert and definition, or nullptr if the identifier is not valid.
Creates a new tool assembly.
The new new tool assembly.
A 3d tool designer applet engine.
Restores the active connection plane to its original state.
Sets the specified workpiece side connection plane as the currently active construction plane.
Information describing the designer.
Identifier for the connection.
Cleans up the connection plane gnomon.
Draws a gnomon on screen for the specified workpiece side connection for the given component.
Information describing the designer.
Identifier for the connection.
Draws a gnomon on screen for the machine side connection for the given component.
Information describing the designer.
The projection adjustment.
Fits the graphics screen to the extents of the component solid.
Information describing the designer.
Fits the graphics screen to the extents of the component tree solids.
Cleans up all graphics managed by this engine.
Gets the solids data.
The IDesignerSolidsData instance.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
Constructor.
The native instance.
An interface providing the graphical capabilities of the 3D Tool and Holder Assembly Component Designers.
Restores the active connection plane to its original state.
Sets the specified workpiece side connection plane as the currently active construction plane.
Information describing the designer.
Identifier for the connection.
Cleans up the connection plane gnomon.
Draws a gnomon on screen for the specified workpiece side connection for the given component.
Information describing the designer.
Identifier for the connection.
Draws a gnomon on screen for the machine side connection for the given component.
Information describing the designer.
The projection adjustment.
Fits the graphics screen to the extents of the component solid.
Information describing the designer.
Fits the graphics screen to the extents of the component tree solids.
Cleans up all graphics managed by this engine.
Gets the solids data.
The IDesignerSolidsData instance.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
An interface providing the graphical capabilities of the 3D Tool and Holder Assembly Component Designers.
Constructor.
The sp native instance.
An interface providing the functional capabilities of the 3D Tool and Holder Assembly Component Designers.
An interface providing the functional capabilities of the 3D Tool and Holder Assembly Component Designers.
Commits the applicable changes to the toolpath operation data.
True if it succeeds, false if it fails.
Copies the cutting parameters to the tool.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
Updates the name of the assembly tree item with the specified identifier.
Identifier for the item.
The updated name.
True if it succeeds, false if it fails.
Updates the assembly name.
The updated name.
True if it succeeds, false if it fails.
Applies the updated spindle speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The spindle speed.
Applies the updated feed rate to the given set of feeds and speeds if applicable for the current
context (milling only)..
The feeds and speeds.
The feed rate.
Applies the updated cutting speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The cutting speed.
Applies the updated feed per tooth to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The feed per tooth.
Applies the feed per tooth and cutting speed to the given set of feeds and speeds if applicable for the
current context (milling only).
The feeds and speeds.
The feed per tooth.
The cutting speed.
Gets access to the toolpath cutting data.
Gets the local 3D tool assembly if applicable for this context.
Gets the local local 2D tool assembly if applicable for this context.
Gets the local mill tool assembly if applicable for this context.
Gets the name of the source machine.
Gets the name of the source workpiece material.
Gets the identifier of the source operation.
Constructor.
The native instance.
Constructor.
The native instance.
An engine interface for use in importing cutting data into toolpath operations.
Commits the applicable changes to the toolpath operation data.
True if it succeeds, false if it fails.
Copies the cutting parameters to the tool.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
The tool assembly could not be applied as it was missing a holder.
The tool assembly could not be applied as it had no insert component.
The tool assembly could not be applied as it had no tool component.
The assembly was not compatible with this toolpath operation context.
Values that represent apply imported assembly error codes.
Updates the name of the assembly tree item with the specified identifier.
Identifier for the item.
The updated name.
True if it succeeds, false if it fails.
Updates the assembly name.
The updated name.
True if it succeeds, false if it fails.
Applies the updated spindle speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The spindle speed.
Applies the updated feed rate to the given set of feeds and speeds if applicable for the current
context (milling only)..
The feeds and speeds.
The feed rate.
Applies the updated cutting speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The cutting speed.
Applies the updated feed per tooth to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The feed per tooth.
Applies the feed per tooth and cutting speed to the given set of feeds and speeds if applicable for the
current context (milling only).
The feeds and speeds.
The feed per tooth.
The cutting speed.
The spindle speed.
The cutting speed.
The feed per tooth.
The feed rate.
Milling feeds and speeds.
Gets access to the toolpath cutting data.
Gets the local 3D tool assembly if applicable for this context.
Gets the local local 2D tool assembly if applicable for this context.
Gets the local mill tool assembly if applicable for this context.
Gets the name of the source machine.
Gets the name of the source workpiece material.
Gets the identifier of the source operation.
An engine interface for use in importing cutting data into toolpath operations.
A no return value placeholder.
Gets the connection plane matrices excluding the current one on the component.
The existing connection plane matrices.
Gets the matrix of the connection plane.
Gets the name of the connection.
Constructor.
The native instance.
Information about a connection.
Updates the connection plane described by planeMatrix.
The plane matrix.
Gets the current connection plane matrix.
Gets the data for this engine.
Gets or sets a value indicating whether the connection plane has been defined.
Gets or sets the connection being designed to be modified.
Gets the current machine side connection transform.
Gets the identifier for the component on the tree.
Gets a copy of the component tree containing the new connection.
Constructor.
If non-null, the native instance.
The data for this engine.
Constructor.
The native instance.
An engine interface for workpiece side connections.
Gets the connection plane matrices excluding the current one on the component.
The existing connection plane matrices.
Gets the matrix of the connection plane.
Gets the name of the connection.
Information about a connection.
Updates the connection plane described by planeMatrix.
The plane matrix.
Gets the current connection plane matrix.
Gets the data for this engine.
Gets or sets a value indicating whether the connection plane has been defined.
Gets or sets the connection being designed to be modified.
Gets the current machine side connection transform.
Gets the identifier for the component on the tree.
Gets a copy of the component tree containing the new connection.
The data for this engine.
An engine interface for workpiece side connections.
Gets the result data.
Marshal result data.
The managed data.
A ProfileImport::IEngine::ResultData instance.
Marshal result data.
Information describing the native.
Nullptr if it fails, else an IEngine::ResultData^.
Constructor.
If non-null, the native instance.
Constructor.
If non-null, the native instance.
An engine adapter.
Fills the given manager with filtered items.
Destination for the items.
Gets the filtered items.
Gets or sets the selected item.
Gets or sets the library path.
Gets or sets a value indicating whether filtering is enabled.
Gets the filter engine.
Constructor.
If non-null, the native instance.
Constructor.
The native instance.
An engine interface for selecting lathe centers.
Gets the filter engine.
An engine interface for selecting lathe centers.
Gets the filter settings.
Gets the maximum rpm field.
Gets the maximum weight field.
Gets the gauge length field.
Gets the point style field.
Gets the taper size field.
Gets the taper style field.
Constructor.
If non-null, the native instance.
The engine's filter settings.
Tests the given item to determine if it satisfies the filter.
The item to test.
True if the item satisfies the filter, false if not.
Gets or sets a value indicating whether filtering is enabled.
Constructor.
The native instance.
Constructor.
The native instance.
An engine interface for filtering lathe centers.
Gets the filter settings.
Gets the maximum rpm field.
Gets the maximum weight field.
Gets the gauge length field.
Gets the point style field.
Gets the taper size field.
Gets the taper style field.
The engine's filter settings.
An engine interface for filtering lathe centers.
Generates the gauge cylinder information for the current center.
The gauge cylinder information if valid, nullopt if not well defined.
Calculates the selected segment set.
The current selection.
(Optional) The last selected segment.
The selected segment.
True to shift input modifier.
True to control input modifier.
The calculated selected segment set.
Generates a tool offset from tool number.
The tool number.
The tool offset from tool number.
Re-initializes the lathe center to defaults.
Queries if AddToTool is enabled in the control definition.
Query if this engine is designing a new center.
Gets the underlying lathe center instance.
Gets the center engine.
Constructor.
The native instance.
The engine interface for designing lathe centers.
Validates the center data.
The result of the validation.
Apply item as local center.
The tool item.
The result of the application.
Applies the imported profile described by importedProfile.
Information describing the import.
True if it succeeds, false if it fails.
Applies the segments described by segments.
The segments.
True if segments are in native units.
Generates a set of segments (top width, bottom width, height) representing the center's geometry .
True to generate in native units, false for system units.
The segments.
Gets a value indicating whether the center's profile contains any arcs.
Gets the maximum radius of the center in the center's native units.
Gets the total length of the center in the center's native units.
Gets or sets the gauge length of the center in the center's native units.
Gets or sets the point style of the center.
Gets or sets the size of the taper on the center.
Gets or sets the taper style of the center.
Gets or sets the maximum RPM that the center can support.
Gets or sets the maximum workpiece weight that the center can support.
Gets or sets the compression length of the center in the center's native units.
Gets or sets a value indicating whether the center is defined in metric units.
Gets or sets the tool offset number of the center.
Gets or sets the tool number of the center.
Gets or sets the catalog identifier of the center.
Gets or sets the manufacturer identifier of the center.
Gets or sets the description of the center.
Gets or sets the name of the center.
Constructor.
The sp native instance.
Constructor.
The sp native instance.
The engine interface for lathe centers.
Validates the center data.
The result of the validation.
The center's geometry does not form a complete boundary.
There's no geometry defined on the center.
The internal TlToolLatheCustom does not contain a TlHolderLatheLiveCenter as its main holder.
No errors were found during validation.
Values that represent validation results.
Apply item as local center.
The tool item.
The result of the application.
Applies the imported profile described by importedProfile.
Information describing the import.
True if it succeeds, false if it fails.
Applies the segments described by segments.
The segments.
True if segments are in native units.
Generates a set of segments (top width, bottom width, height) representing the center's geometry .
True to generate in native units, false for system units.
The segments.
Gets a value indicating whether the center's profile contains any arcs.
Gets the maximum radius of the center in the center's native units.
Gets the total length of the center in the center's native units.
Gets or sets the gauge length of the center in the center's native units.
Gets or sets the point style of the center.
Gets or sets the size of the taper on the center.
Gets or sets the taper style of the center.
Gets or sets the maximum RPM that the center can support.
Gets or sets the maximum workpiece weight that the center can support.
Gets or sets the compression length of the center in the center's native units.
Gets or sets a value indicating whether the center is defined in metric units.
Gets or sets the tool offset number of the center.
Gets or sets the tool number of the center.
Gets or sets the catalog identifier of the center.
Gets or sets the manufacturer identifier of the center.
Gets or sets the description of the center.
Gets or sets the name of the center.
The engine interface for lathe centers.
Gets the result data.
The Source level if imported from a Mastercam level.
The Source file if imported from a file.
Full pathname of the generated transmit file if the profile was imported from a STEP file.
The result profile.
The result code.
Data describing the results from importing tooling profiles.
An engine interface for managing imported tooling profiles.
Updates the tree item name.
Identifier for the tree item.
The updated name for the tree item.
True if it succeeds, false if it fails.
Updates the tree item name.
Identifier for the tree item.
The updated name for the tree item.
True if it succeeds, false if it fails.
Generates information about this assembly's component tree.
The assembly tree information.
Generates information about this assembly's component tree.
The assembly tree information.
Gets or sets the tool station number of the assembly.
Gets or sets the tool station number of the assembly.
Gets or sets the tool number of the assembly.
Gets or sets the tool number of the assembly.
Gets or sets a value indicating whether this assembly is defined in metric units.
Gets or sets a value indicating whether this assembly is defined in metric units.
Gets or sets the name of the assembly.
Gets or sets the name of the assembly.
Gets or sets the external identifier of the assembly.
Gets or sets the external identifier of the assembly.
Gets the identifier of the assembly.
Gets the identifier of the assembly.
Constructor.
If non-null, the native instance.
Constructor.
If non-null, the native instance.
Constructor.
If non-null, the native instance.
Constructor.
If non-null, the native instance.
The data interface for Tool Assemblies.
The data interface for Tool Assemblies.
Updates the tree item name.
Identifier for the tree item.
The updated name for the tree item.
True if it succeeds, false if it fails.
Updates the tree item name.
Identifier for the tree item.
The updated name for the tree item.
True if it succeeds, false if it fails.
Generates information about this assembly's component tree.
The assembly tree information.
Generates information about this assembly's component tree.
The assembly tree information.
The children of this node.
The children of this node.
The name of this node.
The name of this node.
The type of the node.
The type of the node.
The identifier of this node.
The identifier of this node.
An enum constant representing the mill tool option.
An enum constant representing the mill tool option.
An enum constant representing the lathe cutting definition option.
An enum constant representing the lathe cutting definition option.
An enum constant representing the insert option.
An enum constant representing the insert option.
An enum constant representing the turn holder option.
An enum constant representing the turn holder option.
An enum constant representing the extension option.
An enum constant representing the extension option.
An enum constant representing the adapter option.
An enum constant representing the adapter option.
Values that represent types of tree nodes.
Values that represent types of tree nodes.
A tree node.
A tree node.
Gets or sets the tool station number of the assembly.
Gets or sets the tool station number of the assembly.
Gets or sets the tool number of the assembly.
Gets or sets the tool number of the assembly.
Gets or sets a value indicating whether this assembly is defined in metric units.
Gets or sets a value indicating whether this assembly is defined in metric units.
Gets or sets the name of the assembly.
Gets or sets the name of the assembly.
Gets or sets the external identifier of the assembly.
Gets or sets the external identifier of the assembly.
Gets the identifier of the assembly.
Gets the identifier of the assembly.
The data interface for Tool Assemblies.
The data interface for Tool Assemblies.
Updates the model geometry to match the specified set of solids from the graphics screen.
The solids.
Information describing the solids.
True if it succeeds, false if it fails.
Updates the model geometry to match the specified set of solids from the specified file.
The solids.
Full pathname of the file.
True if it succeeds, false if it fails.
Gets the component item being managed by this engine instance.
Null if it fails, else the component item.
Gets model geometry engine.
The model geometry engine.
Constructor.
If non-null, the item.
The native instance.
An engine interface for tooling components and their model geometry.
Updates the model geometry to match the specified set of solids from the graphics screen.
The solids.
Information describing the solids.
True if it succeeds, false if it fails.
Updates the model geometry to match the specified set of solids from the specified file.
The solids.
Full pathname of the file.
True if it succeeds, false if it fails.
Gets the component item being managed by this engine instance.
Null if it fails, else the component item.
Gets model geometry engine.
The model geometry engine.
An engine interface for tooling components and their model geometry.
Exports and saves the data from the specified solid entity pointers into the specified assembly item
instance.
The solids should be in their original orientation, as they were when they were imported. Any connection
plane transformations will be applied to the data stored here when saved on tooling assembly
components.
The solids entity pointers to save.
The item.
(Optional) Information describing the solids to be stored on the item if
provided.
True if it succeeds, false if it fails.
Runs the check solids function on the specified set of solid entity pointers.
The solid entity pointers to check for faults.
True if faults were found, false if not.
Gets a presentable description for the specified set of solids.
The solids.
The description from solids.
Merge in the solids from the specified STEP file.
Full pathname of the file to merge in.
The merged in solids if successful, nullptr if not a valid file.
Gets the solid entity pointers from the specified set of merged in solids.
The solid entity pointers.
Constructor.
The merged in solids.
A designer solids engine base merged in solids adapter.
Constructor.
The native instance.
Constructor.
The native instance.
An interface providing the functional capabilities of the 3D Tool and Holder Assembly Component Designers.
Exports and saves the data from the specified solid entity pointers into the specified assembly item
instance.
The solids should be in their original orientation, as they were when they were imported. Any connection
plane transformations will be applied to the data stored here when saved on tooling assembly
components.
The solids entity pointers to save.
The item.
(Optional) Information describing the solids to be stored on the item if
provided.
True if it succeeds, false if it fails.
Runs the check solids function on the specified set of solid entity pointers.
The solid entity pointers to check for faults.
True if faults were found, false if not.
Gets a presentable description for the specified set of solids.
The solids.
The description from solids.
Merge in the solids from the specified STEP file.
Full pathname of the file to merge in.
The merged in solids if successful, nullptr if not a valid file.
Gets the solid entity pointers from the specified set of merged in solids.
The solid entity pointers.
An interface who's implementation will act as a RAII type that will remove the merged in solids upon
disposal.
This type should be used with a using block representing the scope of solids being merged into the part
file.
An engine interface providing the functional capabilities related to model geometry in the 3D Tooling Designers.
Calculates the CIP (Coordinate system In Process) plane in mounting position.
Options for controlling the operation.
The calculated CIP plane in mounting position.
Calculates the CIP (Coordinate system In Process) plane in primary position.
Options for controlling the operation.
The calculated CIP plane in primary position.
Calculates the MCS (mounting coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated MCS plane in cutting position.
Calculates the MCS (mounting coordinate system) plane in primary position.
Options for controlling the operation.
The calculated MCS plane in primary position.
Calculates the PCS (primary coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated pcs plane in cutting position.
Calculates the PCS (primary coordinate system) plane in mounting position.
Options for controlling the operation.
The calculated pcs plane in mounting position.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
Implementation for the IStandardPlaneCalculator interface.
Calculates the CIP (Coordinate system In Process) plane in mounting position.
Options for controlling the operation.
The calculated CIP plane in mounting position.
Calculates the CIP (Coordinate system In Process) plane in primary position.
Options for controlling the operation.
The calculated CIP plane in primary position.
Calculates the MCS (mounting coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated MCS plane in cutting position.
Calculates the MCS (mounting coordinate system) plane in primary position.
Options for controlling the operation.
The calculated MCS plane in primary position.
Calculates the PCS (primary coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated pcs plane in cutting position.
Calculates the PCS (primary coordinate system) plane in mounting position.
Options for controlling the operation.
The calculated pcs plane in mounting position.
The operation adjustments.
Source for the tool position.
A cutting position parameters.
True if the operation uses a vertical tool spindle.
True if the operation uses the top turret.
The operation user defined quadrant.
The operation B-axis angle.
The operation A-axis angle.
True if the operation uses alternate turret position.
Operation adjustments (e.g., B-Axis angle) that can affect plane locations in space.
Calculates the ISO13399 defined PCS (Primary Coordinate System), MCS (Mounting Coordinate System), and
CIP (Coordinate System in Process) planes for tool assemblies in cutting, mounting (tool change), and
primary positions.
Loads the contents of the library in accordance with the specified parameters.
Options for controlling the load operation.
An instance of the ILibraryData interface using the ILTool type, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Loads the contents of the library in accordance with the specified parameters.
Path to TlAssembly library.
An instance of the ILibraryData interface using the TlAssembly type, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Constructor.
The native instance to adapt.
Loads the contents of the library in accordance with the specified parameters.
Path to ILTool library.
An instance of the ILibraryData interface, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Loads the contents of the library in accordance with the specified parameters.
Path to TlAssembly library.
An instance of the ILibraryData interface, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Validates the given item for compability with internal processes.
The item to validate.
The list of validation errors to output to if validation issues are found.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
The list of validation errors to output to if validation issues are found.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
True if the item is considered to be in a valid state, false if not.
Constructor.
The native instance.
A tool data validator adapter.
Validates the given item for compability with internal processes.
The item to validate.
The list of validation errors to output to if validation issues are found.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
The list of validation errors to output to if validation issues are found.
True if the item is considered to be in a valid state, false if not.
Validates the given item for compability with internal processes.
The item to validate.
True if the item is considered to be in a valid state, false if not.
Interface for a validator to run on imported tooling data.
Restores the manufacturer catalog defaults.
True if it succeeds, false if it fails.
Deletes the given grade from the catalog list.
The grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer from the catalog list.
The manufacturer to delete.
True if it succeeds, false if it fails.
Updates the given grade in the catalog list.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer in the catalog list.
The manufacturer.
True if it succeeds, false if it fails.
Adds the given grade to the catalog list.
The grade to add.
The identifier of the added item.
Adds the given manufacturer to the catalog list.
The manufacturer to add.
The identifier of the added item.
Gets the catalog tools.
The catalog tools.
Gets the catalog tool materials.
The catalog tool materials.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Constructor.
If non-null, the native instance.
Interface into the Mastercam Catalog DataManager.
Restores the manufacturer catalog defaults.
True if it succeeds, false if it fails.
Deletes the given grade from the catalog list.
The grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer from the catalog list.
The manufacturer to delete.
True if it succeeds, false if it fails.
Updates the given grade in the catalog list.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer in the catalog list.
The manufacturer.
True if it succeeds, false if it fails.
Adds the given grade to the catalog list.
The grade to add.
The identifier of the added item.
Adds the given manufacturer to the catalog list.
The manufacturer to add.
The identifier of the added item.
Gets the catalog tools.
The catalog tools.
Gets the catalog tool materials.
The catalog tool materials.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Interface into the Mastercam Catalog DataManager.
Creates a new instance of the I3dLTool interface based on the specified parameters.
Options for controlling the operation.
Nullptr if it fails, else an I3dLTool^.
Creates a new instance of the ILTool interface wrapping the given TlToolLathe instance.
If non-null, the tool assembly.
Nullptr if it fails, else an ILTool^.
Creates a new instance of the IMTool interface wrapping the given TlAssembly instance.
If non-null, the tool assembly.
Nullptr if it fails, else an IMTool^.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
Creates a new instance of the I3dLTool interface based on the specified parameters.
Options for controlling the operation.
Nullptr if it fails, else an I3dLTool^.
Creates a new instance of the ILTool interface wrapping the given TlToolLathe instance.
If non-null, the tool assembly.
Nullptr if it fails, else an ILTool^.
Creates a new instance of the IMTool interface wrapping the given TlAssembly instance.
If non-null, the tool assembly.
Nullptr if it fails, else an IMTool^.
True to create the tool in metric units.
The type of the tool to create.
An enum constant representing the grooving option.
An enum constant representing the threading option.
An enum constant representing the turning boring option.
Values that represent types.
Parameters for creating 3D lathe tools.
A tool interface instance factory.
Creates a new instance of the IUpdateMachineGroupToolApplet interface for updating existing machine group
tools and updating toolpaths that may be using them.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IUpdateMachineGroupToolApplet interface instance.
Creates a new instance of the IMachineGroupToolListEngine interface for working with machine group tools.
The new IMachineGroupToolListEngine interface instance.
Creates a new instance of the IEditToolAssemblyToolApplet interface for editing a tool assembly tool in a
machine group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IEditToolAssemblyToolApplet interface instance.
Creates a new instance of the IEditToolAssemblyHolderApplet interface for editing a tool assembly holder in
a machine group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IEditToolAssemblyHolderApplet interface instance.
Creates a new instance of the IEditToolAssemblyApplet interface for editing a tool assembly in a machine
group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IEditToolAssemblyApplet interface instance.
Creates a new instance of the ICreateToolAssemblyApplet interface for creating tool assemblies in a
machine group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new ICreateToolAssemblyApplet interface instance.
Creates a new instance of the ICreateToolApplet interface for creating tools in a machine group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new ICreateToolApplet interface instance.
Creates a new instance of the IAddToolsToGroupApplet interface for adding tool assemblies to a machine
group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IAddToolsToGroupApplet interface instance.
Creates a new instance of the IAddToolsToGroupApplet interface for adding tools to a machine group.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IAddToolsToGroupApplet interface instance.
Creates a new instance of the IAddToolsToGroupEngine interface for adding tools to machine groups.
The new IAddToolsToGroupEngine interface instance.
Creates a new instance of the IApplet interface for saving tool geometry to a file.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for saving lathe tool geometry to a level.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for saving mill tool geometry to a level.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IAppletEngine interface for saving tool geometry.
The new IAppletEngine interface instance.
Creates a new instance of the ISelectToolFromManagerApplet interface for the purpose of selecting a tool
from the tool manager dialog.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new ISelectToolFromManagerApplet interface instance.
Creates a new instance of the IApplet interface for editing an existing tool.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for creating a new tool.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IAppletEngine interface for designing mill tools.
The new IAppletEngine interface instance.
Creates a new instance of the IApplet interface for editing an existing tool assembly.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for creating a new tool assembly.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IAppletEngine interface for designing mill tool assemblies.
The new IAppletEngine interface instance.
Creates a new instance of the IApplet interface for editing an existing holder.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for designing a new mill holder.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IAppletEngine interface for designing mill holders.
The new IAppletEngine interface instance.
Creates a new instance of the IApplet interface for importing a profile from a level.
If non-null, the profile import engine.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for selecting lathe centers.
If non-null, the engine.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for setting filter settings for lathe centers.
If non-null, the engine.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IGraphicalDisplay interface for displaying graphical elements when
designing a lathe center.
If non-null, the engine.
Nullptr if it fails, else the new IGraphicalDisplay interface instance.
Creates a new instance of the IApplet interface for editing an existing lathe center.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for designing a new lathe center.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for importing a profile from a file.
If non-null, the profile import engine.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IApplet interface for selecting a component model.
If non-null, options for controlling the operation.
Nullptr if it fails, else the new IApplet interface instance.
Creates a new instance of the IEngine interface.
The context for importing cutting data.
The new IEngine interface instance.
Creates a new instance of the IEngine interface for the purpose of creating a new connection.
The component tree.
Identifier for the component.
Initial Type of the connection to create (pass null to use defaults).
Initial Size of the connection to create (pass null to use defaults).
The new IEngine interface instance if the parameters are valid, nullptr if not.
Creates a new instance of the IEngine interface for the purpose of editing an existing connection.
The component tree.
Identifier for the component.
Identifier for the connection to edit on the component.
The new IEngine interface instance if the parameters are valid, nullptr if not.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Creates a new instance of the IEngine interface.
Options for controlling the operation.
The new IEngine interface instance.
Creates a new instance of the IEngine interface.
The lathe center.
The new IEngine interface instance.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Creates a new instance of the IGrToolAssemblyFactory interface.
The new IGrToolAssemblyFactory interface instance.
Creates a new instance of the Engines::ComponentModel::Interop::IEngine interface.
The item instance to manage with the engine.
The new Engines::ComponentModel::Interop::IEngine interface instance.
Creates a new instance of the Engines::ModelGeometry::Interop::IEngine interface.
The new Engines::ModelGeometry::Interop::IEngine interface instance.
Creates a new instance of the IToolDesignerInsertAndDefinitionGraphicsEngine interface.
The new IToolDesignerInsertAndDefinitionGraphicsEngine interface instance.
Creates a new instance of the IToolDesignerInsertAndDefinitionEngine interface.
The new IToolDesignerInsertAndDefinitionEngine interface instance.
Creates a new instance of the IToolDesignerInsertAndDefinitionData interface.
The tool assembly view.
True to initialize the data for creating, false for editing.
The new IToolDesignerInsertAndDefinitionData interface instance.
Creates a new instance of the IToolDesignerGraphicsEngine interface.
The new IToolDesignerGraphicsEngine interface instance.
Creates a new instance of the IToolDesignerEngine interface.
The new IToolDesignerEngine interface instance.
Creates a new instance of the IComponentDesignerGraphicsEngine interface.
The assembly view transform to be applied when building graphical displays.
The new IComponentDesignerGraphicsEngine interface instance.
Creates a new instance of the IComponentDesignerEngine interface.
The new IComponentDesignerEngine interface instance.
Creates a new instance of the IComponentDesignerData interface.
The component tree to modify with the designer.
Identifier for the component to be modified by the designer.
True if the designer is being used to create a component, false if not.
The new IComponentDesignerData interface instance.
Creates an instance of the IStandardPlaneCalculator interface.
The new IStandardPlaneCalculator interface instance.
Creates an instance of the IMappedToolDataTranslator interface.
The new IMappedToolDataTranslator interface instance.
Creates an instance of the IToolDataValidator interface.
The new IToolDataValidator interface instance.
Creates an instance of the ICatalogDataManager.
The new ICatalogDataManager interface instance.
Creates an instance of the ITlToolAssemblyFactory interface.
The new ITlToolAssemblyFactory interface instance.
Creates an instance of the ITlAssemblyFactory interface.
The new ITlAssemblyFactory interface instance.
Creates an instance of the ITlAssemblyItemFactory interface.
The new ITlAssemblyItemFactory interface instance.
Creates an instance of the ITlBitmapFactory interface.
The new ITlBitmapFactory interface instance.
Creates an instance of the IToolFactory interface.
The new IToolFactory interface instance.
Creates an instance of the IToolLibraryLoader interface.
The new IToolLibraryLoader interface instance.
Factory methods for creating instances of the types and services that are part of the tooling API.
(Immutable) the on tool assembly committed callback.
Options for controlling behavior of updating the edited assembly.
Options for controlling the behavior of editing the assembly.
The focus behavior for the mill tool designer as it opens.
The assembly to edit.
A create machine group mill tool assembly parameters.
An edit tool assembly tool applet.
(Immutable) the on tool assembly committed callback.
Options for controlling behavior of updating the edited assembly.
Options for controlling the behavior of editing the assembly.
The specific identifier for the holder on the tool assembly to edit.
The index of the holder on the assembly (-1 for main holder).
The assembly to edit.
A create machine group mill tool assembly parameters.
An edit tool assembly holder applet.
Gets the applet engine.
True if running in read only mode.
Options for controlling the tool.
Options for controlling the behavior of the mill tool designer when editing a tool.
True to enable, false to disable the ok new behavior.
Options for controlling the tool.
Options for controlling the behavior of the mill tool designer when creating a tool.
The focus behavior.
True if from creating or editing from a library context.
The function to be used to commit the the created or edited tool assembly.
Options for controlling how the panel is run. Defaults to a stand-alone function panel.
Options for controlling the behavior of the mill tool designer.
The interface representing the MillToolAssemblyDesigner applet.
Updates the tip treatment for taps.
The tool instance.
True if the tap is a plug tap, false for a bottoming tap.
Loads from level.
The level.
[in,out] The tool instance.
True to overwrite, false to preserve the geometry.
The data that was read from the level.
Saves to level.
The level.
[in,out] The tool instance.
True if it succeeds, false if it fails.
Calculates the maximum cutting deviation between the parameterized and custom anti-collision profiles.
The tool instance.
True, with a double representing the maximum cutting deviation if an anti-collision model exists. False otherwise.
Transfer library tool parameters.
[in,out] The tool instance.
The library object.
True if it succeeds, false if it fails.
Generates a profile from file.
[in,out] The tool instance.
Full pathname of the file.
True to overwrite, false to preserve the geometry.
The profile from file.
Re-calculate the feeds and speeds for the tool.
The tool instance.
Updates the tool to be the specified standard size tool. The tools must be of the same major tool type.
The tool instance.
The standard size tool.
Break custom geometry associations.
The tool instance.
Drops the tool's custom geometry and updates the model.
The tool instance.
Re-generates the name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
Generates a name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
The generated name of the tool.
Updates the corner treatment on the specified tool instance.
The tool instance.
The updated tool corner treatment type.
Automatically adjust the shoulder taper dimensions on the specified tool.
The tool.
Updates the IsMetric state on the specified tool.
The tool instance.
True if setting the value to metric, false for US units.
Updates the shank type of the specified tool, defaulting key shank parameters based on the updated type.
The tool to change the shank type of.
Type of the updated shank type.
Executes the 'tool type changed' action.
The tool to change the type of.
The updated tool type to set the tool to.
Creates a tool instance set up for manipulating in the mill tool designer.
Options for controlling the operation.
The new tool instance.
An applet engine.
Gets the applet engine.
Identifier for the holder to edit on the assembly.
Options for controlling the behavior of the mill tool assembly designer when editing a holder on the assembly.
The mill tool focus behavior.
Options for controlling the behavior of the mill tool assembly designer when editing the assembly tool.
True if running in read only mode.
Options for controlling the tool.
Options for controlling the behavior of the mill tool designer when editing a tool.
True to enable, false to disable the ok new behavior.
Options for controlling the tool.
Options for controlling the behavior of the mill tool designer when creating a tool.
The focus behavior.
True if from creating or editing from a library context.
The function to be used to commit the the created or edited tool assembly.
Options for controlling how the panel is run. Defaults to a stand-alone function panel.
Options for controlling the behavior of the mill tool designer.
The interface representing the MillToolAssemblyDesigner applet.
Adds the specified component above the component with the specified identifier.
The assembly.
Identifier for the component.
The created component.
Determine if we can add component above the component with the specified identifier.
The assembly.
Identifier for the component on the assembly to add above.
True if we can add component above, false if not.
Deletes the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
Determine if we can delete the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
True if we can delete component, false if not.
Updates the assembly tool.
The assembly.
The tool.
Gets the assembly tool for edit.
The assembly.
The assembly tool for edit.
Updates the assembly holder.
The assembly.
The holder.
Gets assembly holder for edit.
The assembly.
Identifier for the holder.
The assembly holder for edit.
Creates a tool assembly instance set up for manipulating in the mill tool assembly designer.
Options for controlling the operation.
The new tool assembly instance.
An applet engine.
Gets the applet engine.
True if running in read only mode.
Options for controlling the holder.
Options for controlling the behavior of the mill holder designer when editing a holder.
True to enable, false to disable the ok new behavior.
Options for controlling the holder.
Options for controlling the behavior of the mill holder designer when creating a holder.
The function to be used to commit the created or edited holder.
Options for controlling how the panel is run. Defaults to a stand-alone function panel.
Common parameters for the mill holder designer.
The interface representing the MillHolderDesigner applet.
The holder to edit.
Parameters used to edit a mill holder instance.
True to create in metric units, false if not.
Parameters used to create a mill holder instance.
The specific level to import from - leave empty to prompt the user for a level.
A parameters.
An applet that imports a tooling profile from a file.
The function to be used to commit the created or edited center.
The engine instance to use by the applet.
Options for controlling the behavior of the lathe center designer when creating.
The function to be used to commit the created or edited center.
The engine instance to use by the applet.
Options for controlling the behavior of the lathe center designer when creating.
The interface representing the Lathe Center Designer applet.
Handle of the parent window.
True to include, false to exclude the cutting geometry.
The specific file to import - leave empty to prompt the user for a file.
A parameters.
An applet that imports a tooling profile from a file.
The action to accept when the user confirms model selection.
True to prompt and select from a file on disk, false to select from the existing solids.
The engine for this applet.
The parameters structure.
True if the selected model has faults.
The selected model description.
The results structure.
An applet for selecting a component model.
Generates the gauge cylinder information for the current center.
The gauge cylinder information if valid, nullopt if not well defined.
Information describing the gauge cylinder of the center.
Calculates the selected segment set.
The current selection.
(Optional) The last selected segment.
The selected segment.
True to shift input modifier.
True to control input modifier.
The calculated selected segment set.
Generates a tool offset from tool number.
The tool number.
The tool offset from tool number.
Re-initializes the lathe center to defaults.
Queries if AddToTool is enabled in the control definition.
Query if this engine is designing a new center.
Gets the underlying lathe center instance.
Gets the center engine.
The tool offset generator.
The tool number generator.
The lathe center to edit (nullptr to create a new one from defaults).
Construction parameters for the engine.
The engine interface for designing lathe centers.
Creates a new instance of the IAppletEngine interface.
The new IAppletEngine interface instance.
Updates the tip treatment for taps.
The tool instance.
True if the tap is a plug tap, false for a bottoming tap.
Loads from level.
The level.
[in,out] The tool instance.
True to overwrite, false to preserve the geometry.
The data that was read from the level.
Saves to level.
The level.
[in,out] The tool instance.
True if it succeeds, false if it fails.
Calculates the maximum cutting deviation between the parameterized and custom anti-collision profiles.
The tool instance.
True, with a double representing the maximum cutting deviation if an anti-collision model exists. False otherwise.
Transfer library tool parameters.
[in,out] The tool instance.
The library object.
True if it succeeds, false if it fails.
Generates a profile from file.
[in,out] The tool instance.
Full pathname of the file.
[in,out] The transmit file.
True to overwrite, false to preserve the geometry.
The profile from file.
Re-calculate the feeds and speeds for the tool.
The tool instance.
Updates the tool to be the specified standard size tool. The tools must be of the same major tool type.
The tool instance.
The standard size tool.
Break custom geometry associations.
The tool instance.
Drops the tool's custom geometry and updates the model.
The tool instance.
Re-generates the name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
Generates a name for the specified tool instance.
The tool instance.
(Optional) The standard size name seed.
The generated name of the tool.
Updates the corner treatment on the specified tool instance.
The tool instance.
The updated tool corner treatment type.
Automatically adjust the shoulder taper dimensions on the specified tool.
The tool.
Updates the IsMetric state on the specified tool.
The tool instance.
True if setting the value to metric, false for US units.
Updates the shank type of the specified tool, defaulting key shank parameters based on the updated type.
The tool to change the shank type of.
Type of the updated shank type.
Executes the 'tool type changed' action.
The tool to change the type of.
The updated tool type to set the tool to.
Creates a tool instance set up for manipulating in the mill tool designer.
Options for controlling the operation.
The new tool instance.
An applet engine.
Creates a new instance of the IAppletEngine interface.
The new IAppletEngine interface instance.
Adds the specified component above the component with the specified identifier.
The assembly.
Identifier for the component.
The created component.
Determine if we can add component above the component with the specified identifier.
The assembly.
Identifier for the component on the assembly to add above.
True if we can add component above, false if not.
Deletes the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
Determine if we can delete the component with the specified identifier off of the given assembly.
The assembly.
Identifier for the component.
True if we can delete component, false if not.
Updates the assembly tool.
The assembly.
The tool.
Gets the assembly tool for edit.
The assembly.
The assembly tool for edit.
Updates the assembly holder.
The assembly.
The holder.
Gets assembly holder for edit.
The assembly.
Identifier for the holder.
The assembly holder for edit.
Creates a tool assembly instance set up for manipulating in the mill tool assembly designer.
Options for controlling the operation.
The new tool assembly instance.
An applet engine.
Creates a new instance of the IAppletEngine interface.
The new IAppletEngine interface instance.
Generates a name.
The holder instance.
The name.
Applies the profile to holder from level.
The holder instance.
The level.
A TlProfileResult.
Generates a profile from file.
The holder instance.
Full pathname of the file.
[in,out] The transmit file.
The profile from file.
Creates a holder instance set up for manipulating in the mill holder designer.
True to create a metric instance, false to create a U.S. units instance.
The new holder instance.
An applet engine.
Creates a new instance of the IGraphicalDisplay interface, representing the graphical display for the
lathe center designer.
The engine to be used.
The new IGraphicalDisplay interface instance.
Sets the selected segment indices, changing the graphical display to indicate that the segments are
selected.
The segment indices.
Gets the zero-based index of the lathe center segment intersecting the specified cursor position.
The cursor position.
The intersecting segment index.
Hides the gauge cylinder.
Shows the gauge cylinder.
Cleans up the graphical display for the lathe center designer.
Rebuilds the gauge cylinder display used when focus is given to the gauge length field within the lathe
center designer.
Rebuilds the graphical display for the lathe center designer.
The graphical display for the lathe center designer applet.
Creates a graphics tool assembly factory.
The new graphics tool assembly factory.
Creates a graphical representation of the "display tool" in the currently active machine group.
True to show the selected operation's tool (if there is only one selected operation),
false to use the user-specified display tool.
The new display tool or nullptr if no display tool has been specified.
Creates a new instance of the IGrToolAssembly interface using the given TlToolLathe.
The assembly to represent as a graphics tool assembly.
An IGrToolAssemblyPtr.
Creates a new instance of the IGrToolAssembly interface using the given 3d Tool assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssemblyPtr.
Creates a new instance of the IGrToolAssembly interface using the given LTool.
The assembly to represent as a graphics tool assembly.
An IGrToolAssemblyPtr.
Creates a new instance of the IGrToolAssembly interface using the given assembly.
The assembly to represent as a graphics tool assembly.
An IGrToolAssemblyPtr.
Creates a new instance of the IGrToolAssembly interface based on the given mill tool slot identifier. If
the there is a mill tool assembly corresponding to the specified slot identifier, a graphics object
will be created. Otherwise, a nullptr will be returned.
Identifier for the mill tool assembly.
An IGrToolAssemblyPtr.
Creates a new instance of the IGrToolAssembly interface based on the given operation id. If the operation
corresponding to the given id has a mill tool, a mill tool assembly graphics object will be created. If the
operation corresponding to the given id has a 3D tool, a 3D tool assembly graphics object will be created.
Otherwise, a nullptr will be returned.
Identifier for the operation.
(Optional) True to ignore tool angle when creating the tool.
An IGrToolAssemblyPtr.
The graphics tool assembly factory.
Creates a new instance of the IToolDesignerInsertAndDefinitionGraphicsEngine interface.
The new IToolDesignerInsertAndDefinitionGraphicsEngine interface instance.
Cleanup clearance dimensions.
Draw clearance end angle dimension.
Information describing the designer.
Draw clearance side angle dimension.
Information describing the designer.
Draw clearance height dimension.
Information describing the designer.
Draw clearance width dimension.
Information describing the designer.
Cleanup cut plunge arrows.
Shows the cut plunge arrows.
Information describing the designer.
Cleans up the stock gnomon.
Draw a gnomon display providing visual context into what direction the tool will be cutting in.
Information describing the designer.
Cleans up the stock display.
Draw a stock display providing visual context into how the tool will be cutting.
Information describing the designer.
Cleanup cut plane direction graphic.
Draw cut plane direction graphic.
Information describing the designer.
Fits the graphics screen to the extents of the insert solid.
Identifier for the insert.
Fits the graphics screen to the extents of the tool solids.
Cleanup the clearance points.
Gets the clearance point data.
A reference to a const IDesignerWireframeData.
Gets the clearance point data.
A reference to an IDesignerWireframeData.
Builds the clearance point data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanup wireframe.
Transform the wireframe in the specified set of designer data after changes to the assembly also within
the designer data.
The designer data.
Gets the wireframe data.
A reference to a const IDesignerWireframeData.
Gets the wireframe data.
A reference to an IDesignerWireframeData.
Builds the wireframe data.
Information describing the designer.
True if it succeeds, false if it fails.
Cleans up all graphics managed by this engine.
Transform the solids in the specified set of designer data after changes to the assembly also within the
designer data.
The designer data.
Gets the extents transform.
A reference to a CM::Transform3D.
Maximum solid extents.
A reference to a const CM::Vector3D.
Minimum solid extents.
A reference to a const CM::Vector3D.
Gets the view that the solids were built in.
A reference to a const CM::Transform3D.
Gets the solids data.
A reference to a const IDesignerSolidsData.
Gets the solids data.
A reference to an IDesignerSolidsData.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
Gets cutting current world transform.
Information describing the designer.
The cutting current world transform.
Gets insert current world transform.
Information describing the designer.
The insert current world transform.
A tool designer insert and definition graphics engine.
Creates a new instance of the IToolDesignerEngine interface.
The new IToolDesignerEngine interface instance.
Deletes the component whose id member matches teh passed in componentId value.
[in,out] Information describing the designer.
Identifier for the component.
True if it succeeds, false if it fails.
Deletes the definition whose id member matches the passed in componentId value. The insertDeleted parameter indicates if the insert was deleted as well due to the last definition being removed.
[in,out] Information describing the designer.
Identifier for the component.
[in,out] True if insert deleted.
True if it succeeds, false if it fails.
Updates the component images as needed described by designerData.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
The solids built to represent the tool assembly.
Updates the boundaries and images after a definition was edited. Boundaries for the edited definition are
considered to be already up to date.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The edited definition.
The solids built to represent the tool assembly after changes have been made.
The map of definition slot to boundary generation result for the definitions that re-generated a boundary.
Updates the boundaries and images after changes.
Requires that the solids have been built according to the current assembly data.
Information describing the designer.
List of states of the previous.
The solids built to represent the tool assembly after changes have been made.
The map of definition slot to boundary generation result for the definitions that re-generated a boundary.
Updates the assembly planes after changes.
Information describing the designer.
List of states of the previous.
Collect the states of the specified tool assembly before any changes are made to the component tree.
The data containing the tool assembly.
A shared pointer instance of component states.
A forward declaration of a type containing the states of an insert and its relationship on the assembly.
Creates view of a copy of the designer data's tool assembly with a new cutting definition associated to
the insert with the specified identifier.
The designer data.
Identifier for the insert to associate the cutting definition onto.
The new tool assembly view with the new definition, or nullptr if the identifier is not valid.
Creates view of a copy of the designer data's tool assembly with a new insert and definition on the turn
holder with the specified identifier.
The designer data.
Identifier for the holder to add the insert onto.
The new view with the new insert and definition, or nullptr if the identifier is not valid.
Creates a new tool assembly.
The new new tool assembly.
A 3d tool designer applet engine.
Creates a new instance of the IComponentDesignerGraphicsEngine interface.
The assembly view transform to be applied when building graphical displays.
The new IComponentDesignerGraphicsEngine interface instance.
Restores the active connection plane to its original state.
Sets the specified workpiece side connection plane as the currently active construction plane.
Information describing the designer.
Identifier for the connection.
Cleans up the connection plane gnomon.
Draws a gnomon on screen for the specified workpiece side connection for the given component.
Information describing the designer.
Identifier for the connection.
Draws a gnomon on screen for the machine side connection for the given component.
Information describing the designer.
The projection adjustment.
Fits the graphics screen to the extents of the component solid.
Information describing the designer.
Fits the graphics screen to the extents of the component tree solids.
Cleans up all graphics managed by this engine.
Gets the solids data.
A reference to a const IDesignerSolidsData.
Gets the solids data.
A reference to an IDesignerSolidsData.
Builds the solids.
Information describing the designer.
True if it succeeds, false if it fails.
Cleanups the given designer data.
An interface providing the graphical capabilities of the 3D Tool and Holder Assembly Component Designers.
Creates a new instance of the IComponentDesignerEngine interface.
The new IComponentDesignerEngine interface instance.
Adds a new component to the assembly from a library.
Information describing the designer.
The selected item.
The child connection identifier.
The assembly tree.
True if it we could convert the component, false if it fails.
Changes an existing component to use model and connection information from a library component.
Information describing the designer.
The selected item.
True if it we could convert the component, false if it fails.
Changes the component type to an adaptive item.
Information describing the designer.
True if this new component type is an extension.
True if this we are making a new component rather than editing one.
True if it we could convert the component, false if it fails.
Changes the component type to a holder.
Information describing the designer.
True if this we are making a new component rather than editing one.
True if it we could convert the component, false if it fails.
An interface providing the functional capabilities of the 3D Tool and Holder Assembly Component Designers.
Creates a new instance of the IEngine interface.
The context for importing cutting data.
The new IEngine interface instance.
Commits the applicable changes to the toolpath operation data.
True if it succeeds, false if it fails.
Copies the cutting parameters to the tool.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Applies the given tool assembly after edits have been made to it.
The assembly must have originated from the local tool assembly on this engine. Changes will be committed
to both the part tool list upon call to CommitChangesToToolpathOperationData.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
Massages the given imported assembly to conform to contextual requirements and applies it to the local
engine data if possible.
TlAssembly can be applied to milling operations only and TlToolAssembly can be applied to turning
operations only. Massaging of TlToolAssembly will include the setting of machine orientation related
parameters to be compatible with the current toolpath operation specified by the import context.
The assembly.
The result.
Values that represent apply imported assembly error codes.
Updates the name of the assembly tree item with the specified identifier.
Identifier for the item.
The updated name.
True if it succeeds, false if it fails.
Updates the assembly name.
The updated name.
True if it succeeds, false if it fails.
Applies the updated spindle speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The spindle speed.
Applies the updated feed rate to the given set of feeds and speeds if applicable for the current
context (milling only)..
The feeds and speeds.
The feed rate.
Applies the updated cutting speed to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The cutting speed.
Applies the updated feed per tooth to the given set of feeds and speeds if applicable for the current
context (milling only).
The feeds and speeds.
The feed per tooth.
Applies the feed per tooth and cutting speed to the given set of feeds and speeds if applicable for the
current context (milling only).
The feeds and speeds.
The feed per tooth.
The cutting speed.
Milling feeds and speeds.
Gets access to the toolpath cutting data.
The cutting data.
Gets access to the toolpath cutting data.
The cutting data.
Gets lathe tool cutting parameters.
Null if it fails, else the lathe tool cutting parameters.
Gets mill tool cutting parameters.
Null if it fails, else the mill tool cutting parameters.
Gets access to the tool assembly data.
The tool assembly data.
Gets the local 3D tool assembly if applicable for this context.
Null if it fails, else a pointer to a const TlToolAssembly.
Gets the local 2D tool assembly if applicable for this context.
Null if it fails, else a pointer to a const TlToolLathe.
Gets the local mill tool assembly if applicable for this context.
Null if it fails, else a pointer to a const TlAssembly.
Gets the machine name.
The machine name.
Gets the source workpiece material.
A reference to a const material.
Gets the source operation.
A reference to a const operation.
An engine interface for use in importing cutting data into toolpath operations.
Attempt to retrieve a localized text string from the error tree.
(Optional) True to fallback to the text contained in this error if no localized text found.
The localized text if found, otherwise std::nullopt.
Gets a value indicating if the text message is localized or not.
True if localized, false if not.
Gets the error code type information.
The type_info for the error code.
Gets the code.
The code.
Sets the inner error.
The inner error.
Gets the inner error.
Null if it fails, else the inner error.
Gets the exception.
The exception, or null if there is none.
Gets the text.
The text.
Constructor.
The error code.
The text.
True if the text is localized, false if not.
The exception.
The inner error.
The type information of the error code to store.
The error base class.
Moves the contained error out of the exception.
A unique pointer to the contained exception.
Get a pointer to the error object this exception is based on, if applicable.
nullptr if no error, else a pointer to the error.
Constructor.
The message.
A wrapper for throwing a result as an exception. Throw results can be either successful or error. This
leads to a copy being performed of pertinent fields in the error, if applicable.
Values that represent core error codes.
Destructor.
Moves the contained error from the given result.
A unique pointer to the contained error from the result object.
A result base class.
Lathe toolpath parameters.
Null if it fails, else a pointer to a const ILatheToolpathParameters.
Lathe toolpath parameters.
Null if it fails, else a pointer to a ILatheToolpathParameters.
Mill toolpath parameters.
Null if it fails, else a pointer to a const IMillToolpathParameters.
Mill toolpath parameters.
Null if it fails, else a pointer to a IMillToolpathParameters.
Query if this toolpath data is for a lathe cutting operation.
True if lathe, false if not.
Query if this toolpath data is for a mill cutting operation.
True if lathe, false if not.
Gets the grooving parameters.
Null if it fails, else a pointer to a const IGroovingParameters.
Gets the grooving parameters.
Null if it fails, else a pointer to a IGroovingParameters.
Gets the threading parameters.
Null if it fails, else a pointer to a const IThreadingParameters.
Gets the threading parameters.
Null if it fails, else a pointer to a IThreadingParameters.
Gets the facing parameters.
Null if it fails, else a pointer to a const IFacingParameters.
Gets the facing parameters.
Null if it fails, else a pointer to a IFacingParameters.
Gets the turning parameters.
Null if it fails, else a pointer to a const ITurningParameters.
Gets the turning parameters.
Null if it fails, else a pointer to a ITurningParameters.
Sets backoff percentage of stepover.
The value.
Gets backoff percentage of stepover.
The backoff percentage of stepover.
Sets the stock clearance between cuts.
The value.
Gets the stock clearance between cuts.
The stock clearance.
Sets finishing depth of cut.
The value.
Gets the finishing depth of cut.
The finishing depth of cut.
Sets roughing depth of cut.
The value.
Gets roughing depth of cut.
The roughing depth of cut.
Grooving parameters.
Sets the spring cut count.
The value.
Gets the spring cut count.
The spring cut count.
Sets the anticipated pulloff distance.
The value.
Gets the pulloff distance.
The pulloff distance.
Sets the finish pass allowance.
The value.
Gets the finish pass allowance.
The finish pass allowance.
Sets the last depth of cut.
The value.
Gets the last depth of cut.
The last depth of cut.
Sets the first depth of cut.
The value.
Gets the first depth of cut.
The first depth of cut.
Threading parameters.
Sets the overcut amount.
The value.
Gets the overcut amount.
The overcut amount.
Sets the retract amount.
The value.
Gets the retract amount.
The retract amount.
Sets finishing depth of cut.
The value.
Gets the finishing depth of cut.
The finishing depth of cut.
Sets roughing depth of cut.
The value.
Gets roughing depth of cut.
The roughing depth of cut.
Facing parameters.
Sets the overlap amount.
The value.
Gets the amount of overlap.
The overlap amount.
Sets the depth of cut.
The value.
Gets the depth of cut.
The depth of cut.
Turning parameters.
Sets the plunge rate.
The value.
The units that the value is defined in.
Gets the plunge rate and the units it is defined in.
The plunge rate and its units.
Sets the feed rate.
The value.
The units that the value is defined in.
Gets the feed rate and the units it is defined in.
The feed rate and its units.
Sets the spindle speed maximum.
The value.
Gets the spindle speed maximum.
The calculated spindle speed maximum.
Sets the spindle speed.
The value.
The units that the value is defined in.
Gets the spindle speed and the units it is defined in.
The spindle speed and its units.
Lathe toolpath parameters.
Sets the radial depth of cut.
The value.
Gets the radial depth of cut if applicable for the current toolpath.
The radial depth of cut or nullopt if not valid for the current context.
Sets the axial depth of cut.
The value.
Gets the axial depth of cut if applicable for the current toolpath.
The axial depth of cut or nullopt if not valid for the current context.
Sets the feed rate.
The value.
Gets the feed rate.
The feed rate.
Sets the spindle speed.
The value.
Gets the spindle speed.
The spindle speed.
Milling toolpath parameters.
Toolpath parameter data.
Creates an instance of the ILatheToolData interface wrapping the given tool assembly instance.
The source for the data.
The definition slot on the data. If the slot is not valid, the primary lathe cutting
definition will be used.
The new ILatheToolData interface.
Creates an instance of the ILatheToolData interface wrapping the given tool assembly instance.
The source for the data.
The new ILatheToolData interface.
Sets the units of the spindle speed (RPM vs CSS).
The value.
Gets the units of the spindle speed (RPM vs CSS).
The spindle speed units.
Sets the units of the plunge rate (Feed/Rev vs Feed/Min).
The value.
Gets the units of the plunge rate (Feed/Rev vs Feed/Min).
The plunge rate units.
Sets the units of the feed rate (Feed/Rev vs Feed/Min).
The value.
Gets the units of the feed rate (Feed/Rev vs Feed/Min).
The feed rate units.
Gets the insert parameters data.
The insert parameters data.
Gets the insert parameters data.
The insert parameters data.
The data interface for Lathe Tool Cutting Parameters.
Sets the dwell time measured in seconds. Only applicable for holemaking parameters.
The value in seconds.
Gets the dwell time measured in seconds. Only applicable for holemaking parameters.
The chip break.
Sets the chip break as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Gets the chip break as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The chip break value.
Sets the peck clearance as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Gets the peck clearance as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The peck clearance value.
Sets the second peck as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Gets the second peck as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The second peck value.
Sets the first peck as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Gets the first peck as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The first peck value.
Sets the maximum thread pitch of the insert if the insert is a threading insert.
The value.
(Optional) True if the value is metric.
Gets the maximum thread pitch of the insert if the insert is a threading insert.
(Optional) True to get the value in the insert's native units.
The thread pitch maximum if the insert can thread, nullopt if not.
Sets the minimum thread pitch of the insert if the insert is a threading insert.
The value.
(Optional) True if the value is metric.
Gets the minimum thread pitch of the insert if the insert is a threading insert.
(Optional) True to get the value in the insert's native units.
The thread pitch minimum if the insert can thread, nullopt if not.
Sets the number of spring cuts if the insert is a threading insert.
The value.
Gets the number of spring cuts if the insert is a threading insert.
The threading spring cut count if the insert can thread, nullopt if not.
Sets the threading pull off if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the threading pull off.
(Optional) True to get value in metric units.
The threading pull off if the insert can groove, nullopt if not.
Sets the threading finish pass allowance if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the threading finish pass allowance.
(Optional) True to get value in metric units.
The threading finish pass allowance if the insert can groove, nullopt if not.
Sets the threading last depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the threading last depth of cut.
(Optional) True to get value in metric units.
The threading last depth of cut if the insert can groove, nullopt if not.
Sets the threading first depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the threading first depth of cut.
(Optional) True to get value in metric units.
The threading first depth of cut if the insert can groove, nullopt if not.
Sets the grooving finish depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the grooving finish depth of cut.
(Optional) True to get value in metric units.
The grooving finish depth of cut if the insert can groove, nullopt if not.
Sets the grooving rough depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the grooving rough depth of cut.
(Optional) True to get value in metric units.
The grooving rough depth of cut if the insert can groove, nullopt if not.
Sets the grooving backoff percent if applicable.
The value.
Gets the grooving backoff percent.
The grooving backoff percent if the insert can groove, nullopt if not.
Sets the grooving stock clearance if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the grooving stock clearance.
(Optional) True to get value in metric units.
The grooving stock clearance if the insert can groove, nullopt if not.
Sets the turning boring facing X overcut amount if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the turning boring facing X overcut amount.
(Optional) True to get value in metric units.
The turning boring facing X overcut amount if the insert can turn, nullopt if not.
Sets the turning boring facing retraction amount if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the turning boring facing retraction amount.
(Optional) True to get value in metric units.
The turning boring facing retraction amount if the insert can turn, nullopt if not.
Sets the turning boring rough overlap amount if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the turning boring rough overlap amount.
(Optional) True to get value in metric units.
The turning boring rough overlap amount if the insert can turn, nullopt if not.
Sets the turning boring finish depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the turning boring finish depth of cut.
(Optional) True to get value in metric units.
The turning boring finish depth of cut if the insert can turn, nullopt if not.
Sets the turning boring rough depth of cut if applicable.
The value.
(Optional) True if the value is in metric units.
Gets the turning boring rough depth of cut.
(Optional) True to get value in metric units.
The turning boring rough depth of cut if the insert can turn, nullopt if not.
Sets the material of the insert.
The value.
Gets the material of the insert.
The material of the insert.
The data interface for Insert parameters.
Creates an instance of the IMillToolData interface wrapping the given tool assembly instance.
The source for the data.
The new IMillToolData interface.
Applies the chip break as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the chip break as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The chip break value.
Applies the peck clearance as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the peck clearance as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The peck clearance value.
Applies the second peck as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the second peck as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The second peck value.
Applies the first peck as an absolute value. Only applicable for holemaking parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the first peck as an absolute value. Only applicable for holemaking parameters.
(Optional) The get value in metric units.
The first peck value.
Applies the finishing Z stepover value. Only applicable for milling parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the finishing Z stepover value. Only applicable for milling parameters.
(Optional) True to get the value in metric units.
The calculated finishing Z stepover value.
Applies the finishing XY stepover value. Only applicable for milling parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the finishing XY stepover value. Only applicable for milling parameters.
(Optional) True to get the value in metric units.
The calculated finishing xy stepover value.
Applies the rough Z stepover value. Only applicable for milling parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the rough Z stepover value. Only applicable for milling parameters.
(Optional) True to get the value in metric units.
The calculated rough Z stepover value.
Applies the rough XY stepover value. Only applicable for milling parameters.
The value.
(Optional) True if the value is in metric units.
Calculates the rough XY stepover value. Only applicable for milling parameters.
(Optional) True to get the value in metric units.
The calculated rough XY stepover value.
Sets the dwell time measured in seconds. Only applicable for holemaking parameters.
The value in seconds.
Gets the dwell time measured in seconds. Only applicable for holemaking parameters.
The chip break.
Sets the chip break as a percentage of tool diameter. Only applicable for holemaking parameters.
The value.
Gets the chip break as a percentage of tool diameter. Only applicable for holemaking parameters.
The chip break.
Sets the peck clearance as a percentage of tool diameter. Only applicable for holemaking parameters.
The value.
Gets the peck clearance as a percentage of tool diameter. Only applicable for holemaking parameters.
The peck clearance.
Sets the second peck value as a percentage of tool diameter. Only applicable for holemaking parameters.
The value.
Gets the second peck value as a percentage of tool diameter. Only applicable for holemaking parameters.
The second peck value.
Sets the first peck value as a percentage of tool diameter. Only applicable for holemaking parameters.
The value.
Gets the first peck value as a percentage of tool diameter. Only applicable for holemaking parameters.
The first peck value.
Sets the drill cycle type. Only applicable for holemaking parameters.
The value.
Gets drill cycle type. Only applicable for holemaking parameters.
The drill cycle type.
Sets the Finishing Z Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The value.
Gets the Finishing Z Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The rough Z stepover as a percentage of tool diameter.
Sets the Finishing XY Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The value.
Gets the Finishing XY Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The rough xy stepover as a percentage of tool diameter.
Sets the Roughing Z Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The value.
Gets the Roughing Z Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The rough Z stepover as a percentage of tool diameter.
Sets the Roughing XY Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The value.
Gets the Roughing XY Stepover as a percentage of tool diameter. Only applicable for milling parameters.
The rough xy stepover as a percentage of tool diameter.
Sets a value indicating if the tool can be used for finishing. Only applicable for milling parameters.
The value.
Gets a value indicating if the tool can be used for finishing. Only applicable for milling parameters.
The value indicating if the tool can be used for finishing if available in this context, nullopt if not.
Sets a value indicating if the tool can be used for roughing. Only applicable for milling parameters.
The value.
Gets a value indicating if the tool can be used for roughing. Only applicable for milling parameters.
The value indicating if the tool can be used for roughing if available in this context, nullopt if not.
Sets the retract rate.
The value.
True if the value is metric.
Gets the retract rate.
(Optional) True to get the value in metric units.
The retract rate.
Gets the cutting diameter of the tool.
(Optional) True to get the value in metric units.
The cutting diameter.
Gets the type of mill tool cutting parameters we are.
The type.
Values that represent types of mill tool cutting parameters.
The data interface for Mill Tool Cutting Parameters.
Sets the material FPT adjustment percentage.
The value.
Gets the material FPT adjustment percentage.
The material FPT adjustment percentage.
Sets the material SFM adjustment percentage.
The value.
Gets the material SFM adjustment percentage.
The material SFM adjustment percentage.
Sets the spindle speed.
The value.
Gets the spindle speed.
The spindle speed.
Sets the plunge rate.
The value.
(Optional) True if the value is metric.
Gets the plunge rate.
(Optional) True to get the value in metric units.
The plunge rate.
Sets the feed rate.
The value.
(Optional) True if the value is metric.
Gets the feed rate.
(Optional) True to get the value in metric units.
The feed rate.
Gets the coolant parameters.
The coolant parameters.
Gets the coolant parameters.
The coolant parameters.
The data interface for Tool Cutting Parameters.
Sets the custom option 7 style state and position.
The state.
The position.
Gets the custom option 7 style state and position.
The custom option 7 style state and position.
Sets the custom option 6 style state and position.
The state.
The position.
Gets the custom option 6 style state and position.
The custom option 6 style state and position.
Sets the custom option 5 style state and position.
The state.
The position.
Gets the custom option 5 style state and position.
The custom option 5 style state and position.
Sets the custom option 4 style state and position.
The state.
The position.
Gets the custom option 4 style state and position.
The custom option 4 style state and position.
Sets the custom option 3 style state and position.
The state.
The position.
Gets the custom option 3 style state and position.
The custom option 3 style state and position.
Sets the custom option 2 style state and position.
The state.
The position.
Gets the custom option 2 style state and position.
The custom option 1 style state and position.
Sets the custom option 1 style state and position.
The state.
The position.
Gets the custom option 1 style state and position.
The custom option 1 style state and position.
Sets the thru-tool style state and position.
The state.
The position.
Gets the thru-tool style state and position.
The thru-tool style state and position.
Sets the mist style state and position.
The state.
The position.
Gets the mist style state and position.
The mist style state and position.
Sets the flood style state and position.
The state.
The position.
Gets the flood style state and position.
The flood style state and position.
Sets the standard coolant status.
The value.
Gets the standard coolant status.
The standard coolant status.
The data interface for coolant parameters.
Creates a new instance of the IEngine interface for the purpose of creating a new connection.
The component tree.
Identifier for the component.
(Optional) Initial Type of the connection to create.
(Optional) Initial Size of the connection to create.
The new IEngine interface instance if the parameters are valid, nullptr if not.
Creates a new instance of the IEngine interface for the purpose of editing an existing connection.
The component tree.
Identifier for the component.
Identifier for the connection to edit on the component.
The new IEngine interface instance if the parameters are valid, nullptr if not.
Gets the connection plane matrices excluding the current one on the component.
The existing connection plane matrices.
Information about a connection.
Updates the connection plane described by planeMatrix.
The plane matrix.
Gets the current connection plane matrix.
The current connection plane matrix.
Gets the data.
The data.
Gets the data.
The data.
The data for this engine.
An engine interface for workpiece side connections.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Gets the filter engine.
The filter engine.
Gets the filter engine.
The filter engine.
An engine interface for selecting lathe centers.
Fills the given manager with filtered items.
Destination for the items.
Sets the library path.
Full pathname of the file.
Gets the library path.
The library path.
Sets the filtering as enabled.
True to enable, false to disable.
Queries if the filtering is enabled.
True if the filtering is enabled, false if not.
A base item selector engine.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Gets the filter settings.
The filter settings.
Gets the filter settings.
The filter settings.
The engine's data.
An engine interface for filtering lathe centers.
Sets the filtering as enabled.
True to enable, false to disable.
Queries if the filtering is enabled.
True if the filtering is enabled, false if not.
A base item filter engine.
Creates a new instance of the IEngine interface.
Options for controlling the operation.
The new IEngine interface instance.
Generates the gauge cylinder information for the current center.
The gauge cylinder information if valid, nullopt if not well defined.
Information describing the gauge cylinder of the center.
Calculates the selected segment set.
The current selection.
(Optional) The last selected segment.
The selected segment.
True to shift input modifier.
True to control input modifier.
The calculated selected segment set.
Generates a tool offset from tool number.
The tool number.
The tool offset from tool number.
Re-initializes the lathe center to defaults.
Queries if AddToTool is enabled in the control definition.
True if the add to tool is enabled, false if not.
Query if this engine is designing a new center.
True if creating new, false if not.
Gets the underlying lathe center instance.
The underlying lathe center instance.
Gets the underlying lathe center instance.
The underlying lathe center instance.
Gets the center engine.
The center engine.
Gets the center engine.
The center engine.
Construction parameters for the engine.
The engine interface for lathe centers.
Creates a new instance of the IEngine interface.
The lathe center.
The new IEngine interface instance.
Validates the center data.
The result of the validation.
Values that represent validation results.
Apply item as local center.
The tool item.
The result of the application.
Applies the imported profile described by importedProfile.
Information describing the import.
True if it succeeds, false if it fails.
Applies the segments described by segments.
The segments.
(Optional) True if segments are in native units.
Generates a set of segments (top width, bottom width, height) representing the center's geometry .
(Optional) True to generate in native units, false for system units.
The segments.
Determines if the center's profile contains any arcs.
True if arcs were found, false if not.
Gets the maximum radius of the center in its native units.
(Optional) True to get value in native units, false for system units.
The maximum radius.
Gets the total length of the center in its native units.
(Optional) True to get value in native units, false for system units.
The total length.
Sets the gauge length of the center.
The value.
True if the value is metric.
Gets the gauge length of the center.
(Optional) True to get value in native units, false for system units.
The gauge length.
Sets the point style of the center.
The value.
Gets the point style of the center.
The point style.
Sets the taper size of the center.
The value.
Gets the taper size of the center.
The taper size.
Sets the taper style of the center.
The value.
Gets the taper style of the center.
The taper style.
Sets the maximum rpm for the center.
The value.
Gets the maximum rpm for the center.
The maximum rpm.
Sets maximum workpiece weight.
The value.
Gets the maximum workpiece weight for the center.
The maximum workpiece weight.
Sets the compression length of the center.
The value.
True if the value is metric.
Gets the compression length of the center.
(Optional) True to get value in native units, false for system units.
The compression length in native units.
Sets the value indicating whether the center is defined in metric units.
True to define the center in metric units.
Gets a value indicating whether the center is defined in metric units.
True if in metric units.
Sets tool offset number.
The value.
Gets the tool offset number.
The tool offset number.
Sets the tool number.
The value.
Gets the tool number.
The tool number.
Sets the catalog identifier of the center.
The value.
Gets the catalog identifier of the center.
The catalog identifier.
Sets the manufacturer identifier.
The value.
Gets the manufacturer identifier.
The manufacturer identifier.
Sets the description of the center.
The value.
Gets the description of the center.
The description.
Sets the name of the center.
The value.
Gets the name of the center.
The name.
The engine interface for lathe centers.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Gets the result data.
The result data.
Gets the result data.
The result data.
Data describing the results from importing tooling profiles.
An engine interface for managing imported tooling profiles.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Creates a new instance of the IData interface.
The tool assembly.
The new IData interface instance.
Updates the tree item name.
Identifier for the tree item.
The updated name for the tree item.
True if it succeeds, false if it fails.
Generates information about this assembly's component tree.
The assembly tree information.
Values that represent types of tree nodes.
A tree node.
Sets the tool station number of the assembly.
The value.
Gets the tool station number of the assembly.
The tool station number.
Sets the tool number of the assembly.
The value.
Gets tool number of the assembly.
The tool number.
Sets a value indicating whether this assembly is defined in metric units.
The value..
Query if this assembly is defined in metric units.
True if metric, false if not.
Sets the name of the assembly.
The value.
Gets the name of the assembly.
The name.
Sets the external identifier the assembly if applicable.
The value.
Gets external identifier of the assembly.
The external identifier.
Gets the identifier of the assembly.
The identifier.
The data interface for Tool Assemblies.
Creates a new instance of the IEngine interface for the purpose of managing the item's model data.
The item.
The new IEngine interface instance.
Updates the model geometry to match the specified set of solids from the graphics screen.
The solids.
Information describing the solids.
True if it succeeds, false if it fails.
Updates the model geometry to match the specified set of solids from the specified file.
The solids.
Full pathname of the file.
True if it succeeds, false if it fails.
Gets the component item being managed by this engine instance.
Null if it fails, else the component item.
Gets model geometry engine.
The model geometry engine.
An engine interface for tooling components and their model geometry.
Creates a new instance of the IEngine interface.
The new IEngine interface instance.
Exports and saves the data from the specified solid entity pointers into the specified assembly item
instance.
The solids should be in their original orientation, as they were when they were imported. Any connection
plane transformations will be applied to the data stored here when saved on tooling assembly
components.
The solids entity pointers to save.
The item.
(Optional) Information describing the solids to be stored on the item if
provided.
True if it succeeds, false if it fails.
Runs the check solids function on the specified set of solid entity pointers.
The solid entity pointers to check for faults.
True if faults were found, false if not.
Gets a presentable description for the specified set of solids.
The solids.
The description from solids.
Merge in the solids from the specified STEP file.
Full pathname of the file to merge in.
The merged in solids if successful, nullptr if not a valid file.
Gets the entity pointers of the solids that have been merged in.
The solid entity pointers.
An RAII type that will remove the merged in solids upon destruction.
An engine interface for model geometry.
Creates a new instance of the IStandardPlaneCalculator interface.
The new IStandardPlaneCalculator interface instance.
Calculates the CIP (Coordinate system In Process) plane in mounting position.
Options for controlling the operation.
The calculated CIP plane in mounting position.
Calculates the CIP (Coordinate system In Process) plane in primary position.
Options for controlling the operation.
The calculated CIP plane in primary position.
Calculates the MCS (mounting coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated MCS plane in cutting position.
Calculates the MCS (mounting coordinate system) plane in primary position.
Options for controlling the operation.
The calculated MCS plane in primary position.
Calculates the PCS (primary coordinate system) plane in cutting position.
Options for controlling the operation.
The calculated pcs plane in cutting position.
Calculates the PCS (primary coordinate system) plane in mounting position.
Options for controlling the operation.
The calculated pcs plane in mounting position.
A cutting position parameters.
Operation adjustments (e.g., B-Axis angle) that can affect plane locations in space.
Calculates the ISO13399 defined PCS (Primary Coordinate System), MCS (Mounting Coordinate System), and
CIP (Coordinate System in Process) planes for tool assemblies in cutting, mounting (tool change), and
primary positions.
Creates a new instance of the IToolLibraryLoader interface.
The new IToolLibraryLoader interface instance.
Loads the contents of the library in accordance with the specified parameters.
Options for controlling the load operation.
An instance of the ILibraryData interface, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Loads the contents of the library in accordance with the specified parameters.
Options for controlling the load operation.
An instance of the ILibraryData interface, containing an entity repository for manipulation, or nullptr
if the load was unsuccessful.
Options for controlling the load operation.
An interface to a library of tooling objects.
Creates a new instance of the IToolDataValidator interface.
The new IToolDataValidator interface instance.
Validates the given item for compability with internal processes.
The item to validate.
(Optional) The log to output messages to if validation issues are found.
True if the item is considered to be in a valid state, false if not.
A tool data validator.
Creates a new instance of the ICatalogDataManager interface.
The new ICatalogDataManager interface instance.
Restores the manufacturer catalog defaults.
True if it succeeds, false if it fails.
Deletes the given grade from the catalog list.
The grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer from the catalog list.
The manufacturer to delete.
True if it succeeds, false if it fails.
Updates the given grade in the catalog list.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer in the catalog list.
The manufacturer.
True if it succeeds, false if it fails.
Adds the given grade to the catalog list.
The grade to add.
The identifier of the added item.
Adds the given manufacturer to the catalog list.
The manufacturer to add.
The identifier of the added item.
Gets the catalog tools.
The catalog tools.
Gets the tool materials.
The tool materials.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Manager for catalog data.
Creates an instance of the IToolFactory interface.
The new IToolFactory instance.
Creates a new tool interface instance from the given database entity.
The database entity.
A tool interface instance, or nullptr if not a valid tool entity.
Creates a new lathe tool interface instance from the given legacy lathe tool.
The tool assembly.
A lathe tool interface instance.
Creates a new 3d lathe tool interface instance from the given 3d tool assembly.
Parameters for controlling the operation.
A 3d lathe tool interface instance.
Values that represent 3d tool type options.
A parameters structure for creating instances of the I3dLTool interface.
Creates a new 3d lathe tool interface instance from the given 3d tool assembly.
The tool assembly.
The definition slot.
A 3d lathe tool interface instance.
Creates a new 3d lathe tool interface instance from the given 3d tool assembly.
The tool assembly.
A 3d lathe tool interface instance.
Creates a new lathe tool interface instance from the given lathe tool assembly.
The tool assembly.
A lathe tool interface instance.
Creates a new mill tool interface instance from the given legacy tool.
The tool assembly.
A tool interface instance.
Creates a new mill tool interface instance from the given tool assembly.
The tool assembly.
A tool interface instance.
Destructor.
A tool factory interface.
Searches for all tools similar to the specified tool in the specified group.
The test assembly.
Identifier for the machine group.
The found similar tools.
Searches for the first tool with the specified tool number in the specified group.
The tool number.
Identifier for the machine group.
The found tool with duplicate tool number.
Finds the tool with the matching identifier in the machine group tool list.
Identifier for the tool assembly.
The found tool or nullptr if not found.
Creates a generator functor that generates a diameter offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new diameter offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a generator functor that generates a length offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new length offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a tool number generator based on the optionally specified machine group information.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new tool number generator if valid for the machine group, or empty if not.
True to issue warnings to the user upon duplicate tool numbers.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
True if warnings should be issued to users when adding a tool with a duplicate tool number.
Gets the flag indicating whether tools should have sequential tool numbers as they're added to the group.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
True if tool numbers should be assigned sequentially, false if not.
Gets the assignable machine group identifier to assign to tool assemblies being added.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
The assignable machine group identifier.
Constructor.
The native instance.
Constructor.
The sp native instance.
An engine supplying functionality for machine group tool list interactions.
Searches for all tools similar to the specified tool in the specified group.
The test assembly.
Identifier for the machine group.
The found similar tools.
Searches for the first tool with the specified tool number in the specified group.
The tool number.
Identifier for the machine group.
The found tool with duplicate tool number.
Finds the tool with the matching identifier in the machine group tool list.
Identifier for the tool assembly.
The found tool or nullptr if not found.
Creates a generator functor that generates a diameter offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new diameter offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a generator functor that generates a length offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new length offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a tool number generator based on the optionally specified machine group information.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new tool number generator if valid for the machine group, or empty if not.
True to issue warnings to the user upon duplicate tool numbers.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
True if warnings should be issued to users when adding a tool with a duplicate tool number.
Gets the flag indicating whether tools should have sequential tool numbers as they're added to the group.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
True if tool numbers should be assigned sequentially, false if not.
Gets the assignable machine group identifier to assign to tool assemblies being added.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
The assignable machine group identifier.
An engine supplying functionality for machine group tool list interactions.
Creates a new instance of the IMachineGroupToolListEngine interface.
The new IMachineGroupToolListEngine interface instance.
Searches for all tools similar to the specified tool in the specified group.
The test assembly.
Identifier for the machine group.
The found similar tools.
Searches for the first tool with the specified tool number in the specified group.
The tool number.
Identifier for the machine group.
The found tool with duplicate tool number.
Finds the tool with the matching identifier in the machine group tool list.
Identifier for the tool assembly.
The found tool or nullptr if not found.
Creates a generator functor that generates a diameter offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new diameter offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a generator functor that generates a length offset value based on a tool number.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new length offset generator if valid, or an empty function if add to tool is not specified in the
machine definition.
Creates a functor to be invoked to determine if a coolant option is enabled for the machine definition
tied to the specified group.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new functor to evaluate if a coolant option is enabled, or empty if not valid for the machine group.
Creates a functor to produce coolant labels for the specified machine group.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new functor to produce coolant labels if valid for the machine group, or empty if not.
Creates a tool number generator based on the optionally specified machine group information.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
The new tool number generator if valid for the machine group, or empty if not.
True to issue warnings to the user upon duplicate tool numbers.
(Optional) Identifier for the machine group - nullopt to use the active machine group
(based on red arrow).
True if warnings should be issued to users when adding a tool with a duplicate tool number.
Gets the flag indicating whether tools should have sequential tool numbers as they're added to the group.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
True if tool numbers should be assigned sequentially, false if not.
Gets the assignable machine group identifier to assign to tool assemblies being added.
(Optional) Identifier for the machine group - nullopt to get the identifier of the
active group or a unique value for no existing group.
The assignable machine group identifier.
An engine supplying functionality for machine group tool list interactions.
Deletes the given item from the repository.
The item to delete.
True if it succeeds, false if it fails.
S-95939: FindAll() is a convenience function in native,
wrapping said function was decided to be out of scope for this story.
Updates the given item in the repository. The item to update. True if it succeeds, false if it fails.
Gets all items in the repository.
All items in the repository.
Adds the TlAssembly item to the repository.
The item to add.
True if it succeeds, false if it fails.
Constructor.
The native instance to adapt.
Deletes the given item from the repository.
The item to delete.
True if it succeeds, false if it fails.
S-95939: FindAll() is a convenience function in native,
wrapping said function was decided to be out of scope for this story.
Updates the given item in the repository. The item to update. True if it succeeds, false if it fails.
Gets all items in the repository.
All items in the repository.
Adds the TlAssembly item to the repository.
The item to add.
True if it succeeds, false if it fails.
A repository of TlAssembly objects, using the generic ITlRepository interface.
The repository.
Saves the library data to the file it was loaded from.
True if it succeeds, false if it fails.
Gets the repository of data.
A reference to an IRepository templated to the library data type.
Constructor.
The native instance to adapt.
Saves the library data to the file it was loaded from.
True if it succeeds, false if it fails.
Gets the repository of data.
A reference to an IRepository templated to the library data type.
Sets the tool assembly's visibility.
Note that the tool/holder will not be visible until the first call to SetToolPos is made. Also, the
"render" flag is ignored if both "tool" and "holder" are false.
If true, make tool visible.
If true, make tool holder visible.
Style flag: true - rendered; false - wireframe.
Sets the tool position to either the WC position (if valid) or VC position.
World to view matrix.
View coordinates position.
World coordinates position.
True if WC position is valid.
Gets the tool position in world coordinates.
Gets or sets the tool plane matrix.
Sets whether or not the tool assembly is drawn as an overlay.
If true, draw the assembly as an overlay.
Sets an existing tool assembly's opacity.
This function may be called after CreateGraphics to adjust the opacity of the assembly.
Opacity [0., 1.].
Destroys the tool assembly graphics.
Creates the tool assembly graphics.
Opacity [0., 1.].
If true, draw the tool assembly as an overlay (i.e. "in front" of other graphics). False
for normal behavior.
If true, don't use this assembly for a fit. False for typical behavior.
True if successful, false otherwise.
Constructor.
The sp native instance.
Managed wrapper implementation of the IGrToolAssembly.
Sets the tool assembly's visibility.
Note that the tool/holder will not be visible until the first call to SetToolPos is made. Also, the
"render" flag is ignored if both "tool" and "holder" are false.
If true, make tool visible.
If true, make tool holder visible.
Style flag: true - rendered; false - wireframe.
Sets the tool position to either the WC position (if valid) or VC position.
World to view matrix.
View coordinates position.
World coordinates position.
True if WC position is valid.
Gets the tool position in world coordinates.
Gets or sets the tool plane matrix.
Sets whether or not the tool assembly is drawn as an overlay.
If true, draw the assembly as an overlay.
Sets an existing tool assembly's opacity.
This function may be called after CreateGraphics to adjust the opacity of the assembly.
Opacity [0., 1.].
Destroys the tool assembly graphics.
Creates the tool assembly graphics.
Opacity [0., 1.].
If true, draw the tool assembly as an overlay (i.e. "in front" of other graphics). False
for normal behavior.
If true, don't use this assembly for a fit. False for typical behavior.
True if successful, false otherwise.
Interface for a graphical tool assembly.
Gets the wireframe data used to draw the tool assembly.
You can process returned revolution and 3d data the same way. Since revolution is the superset,
read the GetWireframe remarks in GrRevToolAssembly.h for more info.
If true, include tool wireframe.
If true, include tool holder wireframe.
Returned transforms for lines and arcs.
Returned wireframe data of assembly components.
True if successful, false if no wireframe data available.
Sets the tool assembly's visibility.
Note that the tool/holder will not be visible until the first call to SetToolPos is made. Also, the "render"
flag is ignored if both "tool" and "holder" are false.
If true, make tool visible.
If true, make tool holder visible.
(Optional) Style flag: true - rendered; false - wireframe.
Sets the tool position to either the WC position (if valid) or VC position.
World to view matrix.
VC position.
WC position.
True if WC position is valid.
Sets the WC tool position.
WC position.
Sets the tool plane matrix.
If the tool assembly graphics have been created, the new tool plane matrix is applied to the
assembly.
Matrix.
Gets the tool plane matrix.
Matrix.
Sets whether or not the tool assembly is drawn as an overlay.
If true, draw the assembly as an overlay.
Sets an existing tool assembly's opacity.
This function may be called after CreateGraphics to adjust the opacity of the assembly.
Opacity [0., 1.].
Destroys the tool assembly graphics.
Creates the tool assembly graphics.
Opacity [0., 1.].
(Optional) If true, draw the tool assembly as an overlay (i.e. "in front" of other
graphics).
(Optional), if true, don't use this assembly for a fit.
True if successful, false otherwise.
Wireframe data for a component of the assembly.
Circle data for GetWireframe.
Arc data for GetWireframe.
Line data for GetWireframe.
Tool assembly graphical object.
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.
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.
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.
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 lathe tools from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given lathe tool from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Deletes the given items from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given item from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Updates the given lathe tools in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given lathe tool in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Updates the given items in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given item in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlCutParams from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGrades from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlManufacturers from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlMaterials from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlInserts from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolMills from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderAssemblies 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 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.
Retrieves a specific object from the library associated to the specified identifier.
The identifier.
The result instance.
True if it succeeds, false if it fails.
Adds 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.
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.
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.
true if it succeeds, false if it fails.
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.
Default Constructor.
The tool library system class.
Utility function that compresses the database.
true if it succeeds, false if it fails.
Display the browse for tool library to save or append dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to save dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to open dialog.
Full path of the library file. Used as the start location
of the dialog, and then used to return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an
updated library path.
true if the library has been migrated, false if not.
Query if the library is updated.
The library must be opened to perform this functionality.
true if updated, false if not.
Query if this object is open.
true if open, false if not.
Gets the full library path including the filename.
The library must be opened to perform this functionality.
The library path.
Gets library filename including the extension.
The library must be opened to perform this functionality.
The library filename.
Gets the library data version.
The library must be opened to perform this functionality.
The library data version.
Gets the library schema version.
The library must be opened to perform this functionality.
The library schema version.
Performs a batch of changes including the addition of items, deletion of items, and the update of items.
The items to add.
The items to delete.
The items to update.
true if it succeeds, false if it fails.
Deletes all items in the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlCutParams from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGrades from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlManufacturers from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlMaterials from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolderLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlInserts from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolders from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolMills from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlTools from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlAssemblies from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes the given lathe tools from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given lathe tool from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Deletes the given items from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given item from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Updates the given lathe tools in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given lathe tool in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Updates the given items in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given item in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all connections from the library.
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlCutParams from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGrades from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlManufacturers from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlMaterials from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlInserts from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolMills from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all mill tools from the library.
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlAssemblies from the library.
The library must be opened to perform this functionality.
The resulting items.
True to locally convert mill tools that are not in an assembly into
an assembly with a default holder, and include them in the resulting items.
true if it succeeds, false if it fails.
Retrieves a specific object from the library associated to the specified identifier.
The identifier.
The result instance.
True if it succeeds, false if it fails.
Adds a vector of lathe tools to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a lathe tool to the library.
The library must be opened to perform this functionality.
The item to add.
True if it succeeds, false if it fails.
Adds the contents of a TlMgr to the library.
The library must be opened to perform this functionality.
The TlMgr to add.
true if it succeeds, false if it fails.
Adds a vector of TlObjectPtrs to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a TlObject item to the library.
The library must be opened to perform this functionality.
The item to add.
true if it succeeds, false if it fails.
Gets filter string.
true if wire machine.
The filter string.
Creates new library at the specified libraryPath.
The library file path, including the filename.
true if it succeeds, false if it fails.
Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location
as the opened library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Updates the library.
The library must be opened to perform this functionality.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Closes the library.
Opens the specified library. Will create the library if it does not exist.
Full pathname of the library file to open.
true to update the library to the latest schema version.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Destructor.
Constructor.
The tool library system class.
Display the browse for tool library to save or append dialog.
Full path of the library file. Used as the start location of the dialog, and then used to
return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to save dialog.
Full path of the library file. Used as the start location of the dialog, and then used to
return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Display the browse for tool library to open dialog.
Full path of the library file. Used as the start location of the dialog, and then used to
return the selected library path.
(Optional) HWnd of the parent.
true if it succeeds, false if it fails.
Utility function that compresses the database.
true if it succeeds, false if it fails.
Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an
updated library path.
true if the library has been migrated, false if not.
Query if the library is updated.
The library must be opened to perform this functionality.
true if updated, false if not.
Query if this object is open.
true if open, false if not.
Gets the full library path including the filename.
The library must be opened to perform this functionality.
The library path.
Gets library filename including the extension.
The library must be opened to perform this functionality.
The library filename.
Gets the library data version.
The library must be opened to perform this functionality.
The library data version.
Gets the library schema version.
The library must be opened to perform this functionality.
The library schema version.
Performs a batch of changes including the addition of items, deletion of items, and the update of items.
The items to add.
The items to delete.
The items to update.
true if it succeeds, false if it fails.
Deletes all items in the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlCutParams from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGrades from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlManufacturers from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlMaterials from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpTypes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlOpGroups from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolderLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlInserts from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlHolders from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolLathes from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlToolMills from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlTools from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes all TlAssemblies from the library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Deletes the given lathe tools from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given lathe tool from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Deletes the given items from the library.
The library must be opened to perform this functionality.
The items to delete.
true if it succeeds, false if it fails.
Deletes the given item from the library.
The library must be opened to perform this functionality.
The item to delete.
true if it succeeds, false if it fails.
Updates the given lathe tools in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given lathe tool in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Updates the given items in the library. The items must already exist in the library.
The library must be opened to perform this functionality.
The items to update.
true if it succeeds, false if it fails.
Updates the given item in the library. The item must already exist in the library.
The library must be opened to perform this functionality.
The item to update.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all lathe tools from the library.
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all connections from the library.
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The vector of resulting items.
true if it succeeds, false if it fails.
Gets all items from the library. Does not includes default assemblies (tools not
in an assembly).
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlCutParams from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGrades from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlManufacturers from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlMaterials from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpTypes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlOpGroups from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTurnHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolderLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlInserts from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlHolders from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolLathes from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlToolMills from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all TlTools from the library.
The library must be opened to perform this functionality.
The resulting items.
true if it succeeds, false if it fails.
Gets all mill tools from the library.
The library must be opened to perform this functionality.
The manager to get all items to.
true if it succeeds, false if it fails.
Gets all TlAssemblies from the library.
The library must be opened to perform this functionality.
The resulting items.
True to locally convert mill tools that are not in an assembly into
an assembly with a default holder, and include them in the resulting items.
true if it succeeds, false if it fails.
Retrieves a specific object from the library associated to the specified identifier.
The identifier.
The result instance.
True if it succeeds, false if it fails.
Adds a vector of lathe tools to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a lathe tool to the library.
The library must be opened to perform this functionality.
The item to add.
True if it succeeds, false if it fails.
Adds the contents of a TlMgr to the library.
The library must be opened to perform this functionality.
The TlMgr to add.
true if it succeeds, false if it fails.
Adds a vector of TlObjectPtrs to the library.
The library must be opened to perform this functionality.
The items to add.
true if it succeeds, false if it fails.
Adds a TlObject item to the library.
The library must be opened to perform this functionality.
The item to add.
true if it succeeds, false if it fails.
Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location
as the opened library.
The library must be opened to perform this functionality.
true if it succeeds, false if it fails.
Updates the library.
The library must be opened to perform this functionality.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
Closes the library.
Opens the specified library. Will create the library if it does not exist.
Full pathname of the library file to open.
true to update the library to the latest schema version.
(Optional) true to create a backup of the pre-updated library.
true if it succeeds, false if it fails.
A tool library system interface.
Marshal a assembly.
If non-null, the assembly.
An Import::MappedToolAssembly.
Marshal a tree node.
If non-null, the tree node.
An Import::MappedToolItemTreeNode.
Marshal a mapped item.
If non-null, the tool item.
An Import::MappedToolItem.
Marshal the given log.
If non-null, the log.
An Import::Log.
Gets the mapping log container to put informative messages about things that happened while mapping the
tool assembly.
Gets or sets the root node.
Gets or sets the tool items.
Gets or sets the performance parameters on the assembly.
Gets or sets the measurements.
Gets or sets the collection of product images.
Gets or sets the last modified date.
Gets or sets the name of the item type.
Gets or sets the description.
Gets or sets the name.
Gets or sets the slot.
A mapped tool assembly.
Gets or sets the collection of children nodes.
Gets or sets the identifier of the item.
A mapped tool item tree node.
Gets the mapping log container to put informative messages about things that happened while mapping the
tool item.
Gets or sets the the model file (should be in STEP file bytes).
Gets or sets the collection of product images.
Gets or sets the item planes.
Gets or sets the unmapped properties.
Gets or sets the mapped properties.
Gets or sets the group.
Gets the or sets type.
Gets or sets the last modified date.
Gets or sets the Type Name.
Gets or sets the Catalog ID.
Gets or sets the name.
Gets or sets the identifier.
A mapped tool item.
Gets or sets the messages.
Gets or sets the contents of the message.
Gets or sets the type of the message.
An enum constant representing the error option.
An enum constant representing the warning option.
An enum constant representing the information option.
Values that represent types of messages.
A log message.
A log message container.
Values that represent performance parameters on a mapped assembly.
An enum constant representing the application option.
An enum constant representing the torque at tool option.
An enum constant representing the power at tool option.
An enum constant representing the number effective flutes option.
An enum constant representing the feed per revolution option.
An enum constant representing the material removal rate option.
An enum constant representing the spindle speed option.
An enum constant representing the feed rate option.
An enum constant representing the cutting speed option.
An enum constant representing the feed per tooth option.
An enum constant representing the radial width of cut option.
An enum constant representing the axial depth of cut option.
An enum constant representing the operation type option.
An enum constant representing the material option.
An enum constant representing the unknown option.
Values that represent measurements on a mapped assembly.
An enum constant representing the gauge length tool assembly option.
An enum constant representing the tool protrusion length option.
An enum constant representing the body length maximum option.
An enum constant representing the depth of cut maximum option.
An enum constant representing the tool assembly length option.
An enum constant representing the body diameter maximum option.
An enum constant representing the cutting diameter maximum option.
An enum constant representing the unknown option.
Values that represent the mapped property from imported data.
An enum constant representing the unknown option.
An enum constant representing the cutting edge length option.
An enum constant representing the tool protrusion length option.
An enum constant representing the body length option.
An enum constant representing the tool lead angle option.
An enum constant representing the step diameter length option.
An enum constant representing the shoulder angle option.
An enum constant representing the plug angle option.
An enum constant representing the plug length option.
An enum constant representing the point length option.
An enum constant representing the shank diameter option.
An enum constant representing the insert length option.
An enum constant representing the cutting width option.
An enum constant representing the tooth count option.
An enum constant representing the thread form option.
An enum constant representing the threading length option.
An enum constant representing the threads per inch option.
An enum constant representing the thread pitch option.
An enum constant representing the thread diameter nominal inch option.
An enum constant representing the thread diameter option.
An enum constant representing the usable length option.
An enum constant representing the insert included angle option.
An enum constant representing the tip angle option.
An enum constant representing the ramp angle maximum option.
An enum constant representing the tool cutting edge angle option.
An enum constant representing the item projection option.
An enum constant representing the flute helix angle option.
An enum constant representing the flute helix hand option.
An enum constant representing the chamfer angle option.
An enum constant representing the chamfer length option.
An enum constant representing the corner radius option.
An enum constant representing the neck diameter option.
An enum constant representing the shoulder diameter option.
An enum constant representing the head length option.
An enum constant representing the shank length option.
An enum constant representing the flute length option.
An enum constant representing the cutting depth option.
An enum constant representing the cutting diameter maximum option.
An enum constant representing the cutting diameter option.
An enum constant representing the overall length option.
An enum constant representing the number of flutes option.
An enum constant representing the body material code option.
An enum constant representing the unit system option.
An enum constant representing the hand option.
An enum constant representing the thru coolant option.
An enum constant representing the hub diameter option.
An enum constant representing the connection diameter option.
An enum constant representing the connection size workpiece side option.
An enum constant representing the connection size machine side option.
An enum constant representing the connection type workpiece side option.
An enum constant representing the connection type machine side option.
Values that represent the type of the mapped assembly item.
An enum constant representing the turn holder option.
An enum constant representing the engrave option.
An enum constant representing the center drill option.
An enum constant representing the dove mill option.
An enum constant representing the index thread mill option.
An enum constant representing the thread mill option.
An enum constant representing the radius mill option.
An enum constant representing the counter bore option.
An enum constant representing the slot mill option.
An enum constant representing the taper mill option.
An enum constant representing the reamer option.
An enum constant representing the tap option.
An enum constant representing the spot drill option.
An enum constant representing the index drill option.
An enum constant representing the drill option.
An enum constant representing the chamfer option.
An enum constant representing the face mill option.
An enum constant representing the index endmill option.
An enum constant representing the ball endmill option.
An enum constant representing the endmill option.
An enum constant representing the undefined option.
An enum constant representing the insert option.
An enum constant representing the round insert option.
An enum constant representing the accessory item option.
An enum constant representing the adapter option.
An enum constant representing the Unknown option.
Values that represent the group of the mapped assembly item.
An enum constant representing the accessory item option.
An enum constant representing the insert option.
An enum constant representing the tool item option.
An enum constant representing the adaptive item option.
An enum constant representing the unmapped option.
Translates the given mapped tool assembly into a TlAssembly instance.
The tool assembly to translate.
The log to output messages to if things go wrong during the process.
A TlAssembly instance if successful, or nullptr if not.
Translates the given mapped tool assembly into a TlAssembly instance.
The tool assembly to translate.
A TlAssembly instance if successful, or nullptr if not.
Translates the given mapped tool item into a TlAssemblyItem instance.
The tool item to translate.
The log to output messages to if things go wrong during the process.
A TlAssemblyItem instance if successful, or nullptr if not.
Translates the given mapped tool item into a TlAssemblyItem instance.
The tool item to translate.
A TlAssemblyItem instance if successful, or nullptr if not.
Constructor.
The native instance.
A mapped tool data translator adapter.
Translates the given mapped tool assembly into a TlAssembly instance.
The tool assembly to translate.
The log to output messages to if things go wrong during the process.
A TlAssembly instance if successful, or nullptr if not.
Translates the given mapped tool assembly into a TlAssembly instance.
The tool assembly to translate.
A TlAssembly instance if successful, or nullptr if not.
Translates the given mapped tool item into a TlAssemblyItem instance.
The tool item to translate.
The log to output messages to if things go wrong during the process.
A TlAssemblyItem instance if successful, or nullptr if not.
Translates the given mapped tool item into a TlAssemblyItem instance.
The tool item to translate.
A TlAssemblyItem instance if successful, or nullptr if not.
An interface to a service providing functionality to translate a mapped tool item or tool assembly into a
Mastercam tool item or tool assembly.
Creates a new instance of the IMappedToolDataTranslator interfaces.
The new IMappedToolDataTranslator interface instance.
Translates the given mapped tool assembly into a TlAssembly instance.
The tool assembly to translate.
(Optional) The log to output messages to if things go wrong during the process.
A TlAssembly instance if successful, or nullptr if not.
Translates the given mapped tool item into a TlAssemblyItem instance.
The tool item to translate.
(Optional) The log to output messages to if things go wrong during the process.
A TlAssemblyItem instance if successful, or nullptr if not.
A mapped tool data translator.
A mapped tool assembly.
A mapped tool item tree node.
A mapped tool item.
Values that represent performance parameters on a mapped assembly.
Values that represent measurements on a mapped assembly.
Values that represent the mapped property from imported data.
Values that represent the type of the mapped assembly item.
Values that represent the group of the mapped assembly item.
Values that represent Message types.
A log message.
A simple log container for use during tooling import processes.
Deletes the given item from the repository.
The item to delete.
True if it succeeds, false if it fails.
S-95939: FindAll() is a convenience function in native,
wrapping said function was decided to be out of scope for this story.
Updates the given item in the repository. The item to update. True if it succeeds, false if it fails.
Gets all items in the repository.
All items in the repository.
Adds the ILTool item to the repository.
The item to add.
True if it succeeds, false if it fails.
Constructor.
The native instance to adapt.
Deletes the given item from the repository.
The item to delete.
True if it succeeds, false if it fails.
S-95939: FindAll() is a convenience function in native,
wrapping said function was decided to be out of scope for this story.
Updates the given item in the repository. The item to update. True if it succeeds, false if it fails.
Gets all items in the repository.
All items in the repository.
Adds the ILTool item to the repository.
The item to add.
True if it succeeds, false if it fails.
A repository of LTool objects, using the generic ITlRepository interface.
Saves the log to disk.
The full pathname of the file to save to.
True if it succeeds, false if it fails.
Logs a message to the logger.
The message.
The type of the message.
Constructor.
The native instance.
A tool data import logger adapter.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ICreateToolApplet managed adapter implementation.
(Immutable) the on tool committed callback.
Options for controlling the adding of the tool to the group.
Options for controlling the creation of the tool.
A create machine group mill tool parameters.
A create tool applet.
Gets the single instance of the ICreateToolApplet::Factory interface instance.
The reference to the ICreateToolApplet::Factory interface instance.
A create machine group mill tool parameters.
A create tool applet.
Marshal as native.
The managed instance.
A ToolFitResult.
Marshal as managed.
The native instance.
A ToolFitResult.
Fits a tool profile to a standard convex tool shape and applies the result to the tool's parameters.
The tool profile.
The mill tool to apply the fit result to.
Fit cut profile to a standard convex tool shape.
The tool profile.
Cutting length of tool. Used to set tool cutting length absolutely if
non-zero.
True to force standard convex tool fit.
The resulting ToolFitResult.
Common tool parameters - The cutting diameter of the tool.
Common tool parameters - The cutting length of the tool.
Common tool parameters - The overall length of the tool.
Common tool parameters - The shank diameter of tool.
The fit tool.
Type of the best fit.
Fifth Region - cylinder top - Additional height of the cylinder after all previous regions.
Fourth Region - upper arc - Upper corner radius.
Third Region Taper - Tangent angle from vertical at end of previous region.
Third Region Taper - Height of angled region.
Second Region - Tangent angle from vertical at start of arc.
Second Region - Curved region from the end of the flat to the next region.
First Region - Horizontal region from the center to the first lift upwards.
A standard convex form tool.
General standard convex form tool. All StandardConvexFormTool parameters are applicable.
Simple taper form tool. All StandardConvexFormTool parameters but LowerTaperAngle are applicable.
Simple cylindrical form tool. Only StandardConvexFormTool FlatRadius, CornerRadius, CylinderHeight are applicable.
An enumerated type representing the type of the best resulting fit.
Only certain StandardConvexFormTool parameters are applicable based on the resulting best fit type.
Encapsulates the result of a tool fit.
Utility functions used to fit custom tool profiles to a standard convex tool shape to aid in parametric
tool definition parameter identification. Usually used on imported custom tool profiles.
Reads tool fit result from file.
The tool fit result.
(Optional) Full pathname of the full file.
True if it succeeds, false if it fails.
Writes a tool fit result to file.
The tool fit result.
(Optional) Full pathname of the full file.
True if it succeeds, false if it fails.
Reads a TlProfile from file.
Simple human readable serialization of TlProfile objects for general debugging and unit testing.
The profile.
(Optional) Full pathname of the full file.
True if it succeeds, false if it fails.
Writes a TlProfile to file in text format.
Simple human readable serialization of TlProfile objects for general debugging and unit testing.
The profile.
(Optional) Full pathname of the full file.
True if it succeeds, false if it fails.
Fits a tool profile to a standard convex tool shape and applies the result to the tool's parameters.
The tool profile.
The mill tool to apply the fit result to.
Fit cut profile to a standard convex tool shape.
The tool profile.
(Optional) Cutting length of tool. Used to set tool cutting length
absolutely if non-zero.
(Optional) True to force standard convex tool fit.
The resulting ToolFitResult.
A StandardConvexFormTool tool definition.
An enumerated type representing the type of the best resulting fit.
Only certain StandardConvexFormTool parameters are applicable based on the resulting best fit type.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The IEditToolAssemblyApplet managed adapter implementation.
(Immutable) the on tool assembly committed callback.
Options for controlling behavior of updating the edited assembly.
Options for controlling the behavior of editing the assembly.
The focus behavior to use when launching the designer.
The assembly to edit.
A create machine group mill tool assembly parameters.
An edit tool assembly applet.
Values that represent focus behaviors.
An enum constant representing the tool projection option, which puts focus on the tool projection field.
An enum constant representing the tool number option, which puts focus on the tool number field.
An enum constant representing the default option, which puts focus on the tool assembly name field.
The diameter offset generator - accepts a tool number.
The length offset generator - accepts a tool number.
The tool assembly instance to edit.
Parameters used for editing an existing tool assembly instance.
Values that represent focus behaviors .
An enum constant representing the primary diameter option, which puts focus on the primary diameter field.
An enum constant representing the default option, which puts focus on the tool name field.
The diameter offset generator - accepts a tool number.
The length offset generator - accepts a tool number.
The tool instance to edit.
Parameters used for editing an existing tool instance.
The diameter offset generator - accepts a tool number.
The length offset generator - accepts a tool number.
The tool number generator.
True to create a tool in metric units.
The tool type.
Parameters used for creating a new tool instance.
Gets the single instance of the IEditToolAssemblyApplet::Factory interface instance.
The reference to the IEditToolAssemblyApplet::Factory interface instance.
Parameters for configuring this applet.
An edit tool assembly applet.
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 identifier of 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 identifier of 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 identifier of 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 identifier of 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.
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, 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.
True if a cutting parameter was selected. False otherwise.
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.
True if a lathe tool assembly 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.
True if a 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 Save Geometry To Level App to save the geometry of the selected mill tool components to one
or more levels.
The selected objects.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save Geometry To Level App to save the geometry of the selected tool components to one or
more levels.
The selected objects.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save Geometry To Level App to save the geometry of the selected lathe tool assemblies to one
or more levels.
The selected tools.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save to Library App to save the items contained within the given container to a library.
The items to save.
Options for controlling the operation.
If non-null, the parent.
The results of the save to library App.
Launches the select insert definition panel to allow users to choose the active definition for their tool.
The multi-definition tool.
The result slot.
If non-null, (Optional) the parent.
(Optional) The initially selected slot.
True if it succeeds, false if it fails.
Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if
successful, will be placed in the input parameter "toolToEdit".
The 3D tool assembly to edit.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
The initially selected slot.
true if it succeeds, false if it fails.
Launches the GAF Projection editing feature to edit the projections of the assembly provided at the input parameter "spResult".
If the assembly is successfully edited, and the input parameter "updatePart" is set to true, the assembly
will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" at that dialog, the newly created assembly will be in parameter "spResult".
The result.
true to update part.
(Optional, 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 mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If
the assembly is successfully edited, and the input parameter "updatePart" is set to true, the
assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spAssembly".
The assembly.
True to update part.
(Optional) True if read only.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the appropriate editor for the given lathe tool. The result of the tool editor, if successful, will be
placed in the input parameter 'spToolToEdit'.
The tool to edit.
The parameters for controlling the operation.
True if it succeeds, false if it fails.
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 tool designer panel to allow users to create a new 3D tool assembly. The result of the tool designer,
if successful, will be placed in the input parameter "spResult".
The result.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the create new lathe center wizard to allow users to create their desired lathe centers. The
result of the create new lathe center wizard, if successful, will be placed in the input parameter
"spResult".
The result.
Identifier for the machine group.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of the
create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
(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.
Launches the create new mill assembly panel. The result of the create new mill assembly panel, if
successful, will be placed in the input parameter "spAssembly".
The assembly.
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 the lathe tool in the internal tool list that corresponds to the given lathe tool interface instance.
The lathe tool.
(Optional, defaults to null) Pass to invoke Tool/Asembly Changed Processing to update all toolpath operations using this tool.
True if it succeeds, false if it fails.
Updates an item in the main part tool list with the input parameter data. The input parameter's
identification information must match an existing item in the main part tool list.
The input.
(Optional, defaults to null) Pass to invoke Tool/Asembly Changed Processing to update all toolpath operations using this tool.
true if it succeeds, false if it fails.
Updates an item in the main part tool list with the input parameter data. The input parameter's
identification information must match an existing item in the main part tool list.
The input.
(Optional, defaults to null) Pass to invoke Tool/Asembly Changed Processing to update all toolpath operations using this tool.
true if it succeeds, false if it fails.
Updates an item in the main part tool list with the input parameter data. The input parameter's
identification information must match an existing item in the main part tool list.
The input.
(Optional, defaults to null) Pass to invoke Tool/Asembly Changed Processing to update all toolpath operations using this tool.
true if it succeeds, false if it fails.
Constructs a list of all lathe tools from the main part tool list. The result list is composed of smart pointers
to interfaces that wrap the items from the internal tool list.
A set of all lathe tools in the main part tool list.
Constructs a list of all items of type TlToolAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolAssembly.
Constructs a list of all items of type TlToolLathe from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolLathe.
Constructs a list of all items of type TlAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlAssembly.
Attempts to locate the lathe tool with a slot number matching the input parameter "slot". If an item is found,
the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find'
returns (by reference parameter) a shared pointer to a const version of the actual item in storage.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the input
parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by
reference parameter) a shared pointer to a const version of the actual item in storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate 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.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Prepares the provided item using the settings in the specified machine group, and then adds the item to
the specified machine group. If not suppressed, this function will warn the user of any similar
items that already exist within the specified machine group. If the add is successful, the input
parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially
station number.
The sp input.
Identifier for the machine group. A value of 'NULL_ID' will add the tool
to the active machine group.
(Out) True if the user cancelled the operation.
(Optional, 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.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. All definitions defined for the given 3D tool
assembly will have a unique slot number assigned to them prior to adding to the tool list.
The item to add to the current part's main tool list.
True if it succeeds, false if it fails.
Adds 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.
Assigns the specified lathe tool to the provided operation.
The lathe tool to be assigned.
The identifier of 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 identifier of 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 identifier of 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 identifier of 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.
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, 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.
True if a cutting parameter was selected. False otherwise.
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.
True if a lathe tool assembly 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.
True if a 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.
True if a lathe 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.
True if a tool assembly was selected. False otherwise.
Prompts the user to select a tool assembly from the tools in the current Mastercam part file.
Output parameter that will be filled in with the selected result.
(Optional, defaults to null) If non-null, the parent.
True if a tool assembly was selected. False otherwise.
Launches the Save Geometry To Level App to save the geometry of the selected mill tool components to one
or more levels.
The selected objects.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save Geometry To Level App to save the geometry of the selected tool components to one or
more levels.
The selected objects.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save Geometry To Level App to save the geometry of the selected lathe tool assemblies to one
or more levels.
The selected tools.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the Save to Library App to save the items contained within the given container to a library.
The items to save.
Options for controlling the operation.
If non-null, the parent.
The results of the save to library App.
The select library tab from which the save operation was launched.
The mill holder tab.
The mill tool tab.
The mill tool assembly tab.
The lathe holder tab.
The lathe insert tab.
The lathe tool assembly tab.
Values that represent library tabs.
True if saving lathe components.
True if saving from a library list.
Full pathname of the library file.
A save to library parameters.
Full pathname of the library file.
True if the data was saved.
Encapsulates the result of a save to library.
Launches the select insert definition panel to allow users to choose the active definition for their
tool.
The multi-definition tool.
The result slot.
True if it succeeds, false if it fails.
Launches the select insert definition panel to allow users to choose the active definition for their
tool.
The multi-definition tool.
The result slot.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the select insert definition panel to allow users to choose the active definition for their
tool.
The multi-definition tool.
The result slot.
If non-null, the parent.
The initially selected slot.
True if it succeeds, false if it fails.
Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if
successful, will be placed in the input parameter "toolToEdit".
The 3D tool assembly to edit.
True to hide the parent window before launching the tool designer.
true if it succeeds, false if it fails.
Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if
successful, will be placed in the input parameter "toolToEdit".
The 3D tool assembly to edit.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if
successful, will be placed in the input parameter "toolToEdit".
The 3D tool assembly to edit.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
The initially selected slot.
true if it succeeds, false if it fails.
Launches the GAF Projection editing feature to edit the projections of the assembly provided at the input
parameter "spResult". If the assembly is successfully edited, and the input parameter "updatePart" is
set to true, the assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" at that dialog, the newly created assembly will be in parameter "spResult".
The result.
true to update part.
true if the assembly has changed, 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, 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.
true if it succeeds, false if it fails.
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.
true if it succeeds, false if it fails.
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.
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.
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.
True to present the editor in read-only mode.
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 mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If
the assembly is successfully edited, and the input parameter "updatePart" is set to true, the
assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spAssembly".
The assembly.
True to update part.
true if it succeeds, false if it fails.
Launches the mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If
the assembly is successfully edited, and the input parameter "updatePart" is set to true, the
assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spAssembly".
The assembly.
True to update part.
True if read only.
true if it succeeds, false if it fails.
Launches the mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If
the assembly is successfully edited, and the input parameter "updatePart" is set to true, the
assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spAssembly".
The assembly.
True to update part.
True if read only.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the appropriate editor for the given lathe tool. The result of the tool editor, if successful, will be
placed in the input parameter 'spToolToEdit'.
The tool to edit.
The parameters for controlling the operation.
True if it succeeds, false if it fails.
The parent window.
The option to hide the parent window if it is not null. Only valid if from a designer-based editor.
The ID of the operation currently being edited. Only valid if 'fromOpDialog' is true.
The flag to specify that the tool is being edited from an operations dialog.
The option to update the tool and all operations to use that tool in the part file..
Parameters for controlling behavior when editing a lathe tool.
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.
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.
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.
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.
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. D
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 tool designer panel to allow users to create a new 3D tool assembly. The result of the tool
designer, if successful, will be placed in the input parameter "spResult".
The result.
True to hide the parent window before launching the tool designer.
true if it succeeds, false if it fails.
Launches the tool designer panel to allow users to create a new 3D tool assembly. The result of the tool
designer, if successful, will be placed in the input parameter "spResult".
The result.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the create new lathe center wizard to allow users to create their desired lathe centers. The
result of the create new lathe center wizard, if successful, will be placed in the input parameter
"spResult".
The result.
Identifier for the machine group.
true if it succeeds, false if it fails.
Launches the create new lathe center wizard to allow users to create their desired lathe centers. The
result of the create new lathe center wizard, if successful, will be placed in the input parameter
"spResult".
The result.
Identifier for the machine group.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of
the create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
True if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of
the create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
(Optional, defaults to null) If non-null, the parent.
True if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of
the create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
True if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of the
create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
(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.
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.
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.
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.
Launches the create new mill assembly panel. The result of the create new mill assembly panel, if
successful, will be placed in the input parameter "spAssembly".
The assembly.
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.
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.
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.
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.
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 the lathe tool in the internal tool list that corresponds to the given lathe tool interface
instance.
The lathe tool.
True if it succeeds, false if it fails.
Updates the lathe tool in the internal tool list that corresponds to the given lathe tool interface
instance.
The lathe tool.
(Optional, defaults to null) Pass to invoke Tool/Assembly Changed Processing to
update all toolpath operations using this tool.
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.
(Optional, defaults to null) Pass to invoke Tool/Assembly Changed Processing to
update all toolpath operations using this tool.
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.
(Optional, defaults to null) Pass to invoke Tool/Assembly Changed Processing to
update all toolpath operations using this tool.
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.
(Optional, defaults to null) Pass to invoke Tool/Assembly Changed Processing to
update all toolpath operations using this tool.
true if it succeeds, false if it fails.
Indicates an offset warning has occurred.
The created assembly (only populated if the user selected CreateNewAssembly via UI or AutomationMode = AssemblyChangedResult::CreateNewAssembly).
The automation mode to use if Automate = true.
Cancel Changes.
Create a new assembly.
Update all assemblies.
Automation Modes.
Automate Assembly/Tool Changed Processor UI prompts.
Note: The automation parameters include this automation flag so that the caller may capture a reference to a created assembly or
if an offset warning has occurred, even when automation is off and the user is prompted via the UI for how to handle
AssemblyChanged decisions.
IToolSystem::Update(...) automation parameters.
Constructs a list of all lathe tools from the main part tool list. The result list is composed of smart pointers
to interfaces that wrap the items from the internal tool list.
A set of all lathe tools in the main part tool list.
Constructs a list of all items of type TlToolAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolAssembly.
Constructs a list of all items of type TlToolLathe from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolLathe.
Constructs a list of all items of type TlAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlAssembly.
Attempts to locate the lathe tool with a slot number matching the input parameter "slot". If an item is found,
the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find'
returns (by reference parameter) a shared pointer to a const version of the actual item in storage.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the input
parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by
reference parameter) a shared pointer to a const version of the actual item in storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate 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 identifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate 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 identifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
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.
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.
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.
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.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Prepares the provided item using the settings in the specified machine group, and then adds the item to
the specified machine group. If not suppressed, this function will warn the user of any similar
items that already exist within the specified machine group. If the add is successful, the input
parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially
station number.
The sp input.
Identifier for the machine group. A value of 'NULL_ID' will add the tool to the
active machine group.
(Out) True if the user cancelled the operation.
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.
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.
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.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. All definitions defined for the given 3D tool
assembly will have a unique slot number assigned to them prior to adding to the tool list.
The item to add to the current part's main tool list.
True if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Interface into the main Mastercam tool system.
Suspend operation manager refresh until this is destroyed.
An operation manager refresh object that contains the operation IDs to refresh in the main Operation
Manager.
Return true if operation exists in the database maps.
Identifier for the operation.
True if it exists, false if not.
Pointer to operation info to use to refresh the main OpMgr. If this exists it means
that DatabaseUpdate() will not call the OpMgr to update.
Reference to an OpMgrRefreshMap that we'll use to update the main OpMgr when this
goes out of scope.
Disables the refresh.
True to disable, false to enable.
Preturn previous value of m_RefreshDisabled.
map of operation ID's and the number of times TpPartOpList::DatabaseUpdate() was
called for each operation while the OpMgr update was suspended.
Destructor.
Constructor.
[in,out] Reference to an OpMgrRefreshMap that we'll use to
update the main OpMgr when this goes out of scope.
Class that contains operation information used to compare and see if the main OpMgr
requires an update.
Replaces the operation with the given ID in the refresh map m_RefreshMap.
Identifier for the operation.
True if it succeeds, false if it fails.
Removes the operation with the given ID from the refresh map m_RefreshMap.
The operation Identifier to remove.
Adds the operation with the given ID to the refresh map m_RefreshMap.
Identifier for the operation.
True if it succeeds, false if it fails or operation already exists in the map.
Destructor.
Constructor.
Name of our current file.
[in,out] Reference to main Operation Manager we'll be refreshing.
[in,out] Reference to operation list.
Constructor.
The operation.
Default constructor.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Constructor.
the operation.
A class containing all the operation parameters whose values
are displayed in the tree control.
Information about the operation to compare when refreshing the OpMgr.
Class to keep track of which operations need to be refreshed in the OpMgr when the
OpMgr's updates are temporarily suspend.
First operation index using the 3D tool specified by the given identifier.
Identifier for the tool.
(Optional) Identifier for an operation to exclude.
An INT_PTR to the first operation using the 3D tool.
First operation using the 3D tool specified by the given identifier.
Identifier for the tool.
(Optional) Identifier for an operation to exclude.
Null if it fails, else a pointer to the first operation using the 3D tool.
Sort the given IDs by container order.
The operation IDs to sort.
std::vector of sorted operation IDs.
Updates the list and database.
The operation entity.
True to update time stamp.
(Optional) True to update x coordinate form.
(Optional) Pointer to EntityMap containing current db info used for dependent
operations.
True if it succeeds, false if it fails.
Database update.
The operation entity.
True to update time stamp.
(Optional) True to update dependents.
(Optional) Pointer to EntityMap containing current db info used for dependent
operations.
True if it succeeds, false if it fails.
Fix operation slot numbers when hidden groups exist.
List of groups we belong to.
True to sort list the underlying container by ascending slot number.
True to update operation entities in the current database.
IDs of operations that were updated.
Sort ascending by operation.slot number.
True if it succeeds, false if it fails.
Sort a vector of operation pointers.
[in,out] [in,out] If non-null, the operation ptrs.
The sorting less-than function.
The include mask function.
True if it succeeds, false if it fails.
Gets the next available absolute value frome the given list of long values.
List of used operation IDs.
The next absolute long value.
Check if operation contains surface TP ents.
Identifier for the operation.
True if it does, false if not.
Gets operation surface counts for the operation.
Identifier for the operation.
The operation surface counts.
Test opcode to see if surface operation code requires geometry branches in the
Operation Manager.
The operation code to test.
True if operation type requires geometry branches in the OpMgr.
Increment our counts for the given tpEnt.
The toolpath entity to check.
True if any count was incremented, false if not.
Query if all counts are zero.
True if empty, false if not.
Query if 'obj' is equal.
The object.
True if equal, false if not.
List of surface-entity-type counts.
@defgroup assocvar_ch44 spindle direction
@{
@}
@defgroup assocvar_ch45 drill pt initial values
@{
@}
@defgroup assocvar_ch47 TP_CHN types
@{
@}
@defgroup assocvar_ch62 1013 nci line opcodes - LATHE
@{
@}
@defgroup assocvar_ch63 3D HMM Toolpath types
@{
@}
@defgroup assocvar_ch64 2D HMM Toolpath styles
@{
@}
@defgroup assocvar_ch65 Wirepath types
@{
@}
@defgroup assocvar_ch66 Agie machine model and control limits
@{
@}
reference point bits, used with ref_pt_state
@}
@defgroup assocvar_ch41 material type constants
@{
@}
@defgroup assocvar_ch42 tool active head/turret and axis motion constants
@{
@defgroup assocvar_ch2 Toolpath Regeneration Error Codes
@{
@}
@defgroup assocvar_ch4 rotary axis (stored in bnci)
@{
@}
@defgroup assocvar_ch10 contour-pocket change at point codes
@{
@}
@defgroup assocvar_ch11 Wire change at point codes
@{
@}
@defgroup assocvar_ch12 Wire control setting codes
@{
@}
@defgroup assocvar_ch13 Wire control flag codes
@{
@}
@defgroup assocvar_ch14 maximum number of parameters on an NCI line
@{
@}
@defgroup assocvar_ch25 coolant states
@{
@}
@defgroup assocvar_ch37 transform operation types
* @warning make sure you update sizeof_operation() in assocnci.c with any new opcodes
@{
@}
@defgroup assocvar_ch38 1013 nci line opcodes - Wire
@{
@}
@defgroup assocvar_ch39 cutter compensation constants
@{
Cutter compensation direction.
Gets a reference to the global variable 'current_version' representing the version of the current
Mastercam session.
The version of the current Mastercam session.
Gets a reference to the global variable 'pNciBinFileClass' representing the pointer to the file class for
binary nci.
All of the bnci functions are implemented to use pNciBinFileClass and will also swap with pointers to
other instances of the SysFile class. pNciBinFileClass replaces what used to be fnci_bin.
The pointer to file class for binary nci.
Gets a reference to the global variable 'TpMainOpMgr' representing the main operations list manager.
The main operations list manager.
Gets a reference to the global variable 'TpMainGrpMgr' representing the main groups list manager.
The main groups list manager.
Gets a reference to the global variable 'TpMainMatMgr' representing the main materials list manager.
The main materials list manager.
Gets a reference to the global variable 'db_end' representing the ending address of the database linked
list.
The ending address of the database linked list.
Gets a reference to the global variable 'db_start' representing the starting address of the database
linked list.
The starting address of the database linked list.
@par Purpose:
This virtual method override pops list objects off of the list stacks.
@return Returns true if the list objects were popped off the stacks correctly and false if not.
@par Purpose:
This virtual method override pushes new list objects onto the list stacks.
@return Returns true if new list objects were pushed onto the stacks correctly and false if not.
@par Purpose:
This is the default TpOpMgr destructor. It empties all of the list stacks upon destruction.
@par Purpose:
This is the default TpOpMgr constructor. It initializes the list stacks upon creation.
@par Purpose:
This virtual method empties all of the list stacks. This method is marked as private because
the list stacks should only be emptied when the manager gets destructed.
@return A boolean value indicating whether the emptying of the lists stacks was successful or not.
This is the manager class's main operation list stack. This is where instances of our main operation lists get stored.
@par Purpose:
This class's purpose is to hold and work with instances of the op manager operation list classes for the life
of a given Mastercam app execution. It also houses the operation list stacks themselves, which we use to manage
temporary list creation situations (see base TpMgr class declaration for more details).
@par Purpose:
This method checks a group list for a machine group. If none is found, one is created. If bad group
pointers are found, they are fixed and reset to valid groups.
@param[in] g The group list object to validate a machine group in.
@par Purpose:
This method sets the current views based on the saved view information stored in a group structure.
@param[in] Group The group data that should be used to reset the current view information.
@param[in] setActivePlanes true = set the active planes (Cplane, Tplane, WCS) as well
@param[in] coordinateDisplay MILL_COORD, LATHE_COORD_X, LATHE_COORD_D or -1 to extract from given machine group.
@par Purpose:
This virtual method override pops list objects off of the list stacks.
@return Returns true if the list objects were popped off the stacks correctly and false if not.
@par Purpose:
This virtual method override pushes new list objects onto the list stacks.
@return Returns true if new list objects were pushed onto the stacks correctly and false if not.
@par Purpose:
This is the default TpGrpMgr destructor. It empties all of the list stacks upon destruction.
@par Purpose:
This is the default TpGrpMgr constructor. It initializes the list stacks upon creation.
@par Purpose:
This virtual method empties all of the list stacks. This method is marked as private because
the list stacks should only be emptied when the manager gets destructed.
@return A boolean value indicating whether the emptying of the lists stacks was successful or not.
This is the manager class's file read group list stack. This is where instances of our file read group lists get stored.
This is the manager class's main group list stack. This is where instances of our main group lists get stored.
@par Purpose:
This class's purpose is to hold and work with instances of the op manager group list classes for the life
of a given Mastercam app execution. It also houses the group list stacks themselves, which we use to manage
temporary list creation situations (see base TpMgr class declaration for more details). Finally, it holds
some utility functions for managing global group related states and for searching lists for machine groups.
True to disable regeneration of m_LookupMap in Delete(), false to enable.
This is the list class's ID lookup map. When enabled, this map serves to map IDs to their indices within the list.
This is the list class's main array object where all of the op_groups are stored.
Check and correct if toolpath groups reference geometry groups as their parent (or vice versa).
List of groups to chack and correct.
A list of group IDs corrected.
Copy a list of groups.
[in,out] List of groups to copy, will be sorted and maybe IDs will be
renumbered.
Adds a group freshly read from a file to 'pCurrentGroupList'.
Group to add.
If non-null, the current group list.
List of existing names to prevent duplicates.
True if it succeeds, false if it fails.
Disables rebuilding of m_LookupMap in DeleteGroupNode().
True to disable, false to enable.
True if it succeeds, false if it fails.
Query if this object is the global TpGrpList.
True if global, false if not.
Regenerate m_LookupMap.
Free memory at the given pointer.
[in,out] If non-null, the group to free.
True if it succeeds, false if it fails.
Allocate op_group to store in m_MainArray.
group to copy into allocated group.
nullptr if it fails, else a pointer to an op_group.
Removes any null ptrs from m_MainArray and rebuilds m_LookupMap.
Return number of nullptr entries removed from m_MainArray.
Gets a reference to the underlying lookup map.
A reference to the underlying lookup map.
Allocates for and adds a copy of the given op_group to m_MainArray.
[in,out] The op_group to add.
Null if it fails, else a pointer to the copy of the op_group.
Deletes all groups.
The machine group deletion parameters, ignored if not a machine group.
True if it succeeds, false if it fails.
Deletes the group and all it's child groups with the given ID.
Identifier for the group to delete.
True to ignore children, false = delete the child groups.
The machine group deletion parameters, ignored if not a machine group.
A list of group IDs of deleted groups.
Deletes the extra data hanging off machine groups which shouldn't be there in the
first place.
[in,out] The group to check.
If opGroup is a machine group, use these deletion parameters for the
extra data hanging off the machine group.
True if it succeeds, false if it fails.
Gets the identifiers for all the groups.
The group IDs in m_MainArray order.
Return true if index is within range of m_MainArray.
Zero-based index into m_MainArray.
Return true if index is within range of m_MainArray.
Sets the active operation group in the main Operation Manager )moves the red insert
arrow). Will also create a machine group and/or a toolpath if none exists.
Identifier for the group to set as active.
A group ID of the group set as the active operation group.
Writes our groups to the given file.
[in,out] The file to write to.
True = only write geometry groups, not toolpath groups.
True if it succeeds, false if it fails.
Reads groups from a file into given TpGrpList.
[in,out] The file to read groups from.
[in,out] If non-null, a TpGrpList to store groups.
True if it succeeds, false if it fails.
Transfer the contents of source into our m_MainArray.
[in,out] Source to move into out m_MainArray.
ListReturnCode::ListOperationOK, ListOperationFailed or ListIndexNotFound.
Transfer the contents of m_MainArray to the given target.
[in,out] Target for m_MainArray contents.
ListReturnCode::ListOperationOK, ListOperationFailed or ListIndexNotFound.
Query if this object is empty.
True if empty, false if not.
Gets the size of m_MainArray.
The size of m_MainArray.
Destructor.
Constructor.
Initial size of the underlying container.
Default constructor.
Compares the Mastercam file's major & minor version number of the file at the
given path to our current major version number.
The Mastercam source file to check.
True to warn of previous version file.
Return true if file is okay to read from.
Gets an entity by its unique ID number (ent.ent_idn).
The entity's ent.ent_idn.
Shared ptr to a copy of the entity.
Extracts and returns any non-toolpath type groups in the given list of group pointers.
[in,out] List of group pointers to look through.
List of non-toolpath type group pointers.
Sort the group vector by the given list of group pointers.
List of group pointers in the desired order.
[in,out] List of groups to sort.
True if it succeeds, false if it fails.
Dumps the given toolpath groups to a file.
List of toolpath groups to dump.
The file name to write to.
Sort group pointers by parent-child hierarchy.
The toolpath group pointers to sort.
first = true if group sort order is valid, second = true if sort order was updated,
third = true if slot numbers were updated.
Sort groups by parent-child hierarchy.
[in,out] The toolpath groups to sort.
first = true if group sort order is valid, second = true if sort order was updated,
third = true if slot numbers were updated.
Check if the parent groups reside before their children in the vector.
Source vector of toolpath group pointers to check.
true = make sure any parent groups exist in the
passed in source, false = ignore missing parent
groups.
True to check slot number values in the groups.
True if it all parent groups reside before their children, false if not.
Makes a unique, unused group name.
True if is machine group, false if not.
If not empty, the name we'd like to use if not already used.
List of existing group names to check for naming conflicts.
The next available group name.
Create a vector of group pointers from the given vector.
[in,out] Reference to list of groups.
A list of group pointers to the groups.
Sort the given groups by the sort method.
[in,out] List of groups.
The sort method.
True if it succeeds, false if it fails.
Sort the given group pointers by the sort method.
[in,out] List of group pointers.
The sort method.
True if it succeeds, false if it fails.
Test ourselves
Zero-out machine and job setup values in the given group.
[in,out] The group to initalize.
Dumps all the groups to the given file.
The IDs of the groups to dump, empty = dump all groups.
The file name to write to.
Dumps all the groups to the given file.
The file name to write to.
Dumps all the groups to the given file.
The IDs of the groups to dump, empty = dump all groups.
The file name to write to.
Dumps a group in detail.
The group to dump.
If non-null, the entity map, nullptr = make new map.
[in,out] The array of strings to fill in.
Returns a string of group info with minimal other details.
The group to dump.
A string of group info with minimal other details.
Gets a description for the given group type.
Type of the group.
The group type description.
Check for geometry group type.
Type of the group.
(Optional) True to warn.
True if geometry group type, false if not.
Initializes the machine information in all groups that reference the given machine data.
Machine pointer to match.
The machine entity's ent.ent_idn to match.
Returns list of IDs of the updated groups.
Gets a pointer to the the first toolpath-type group.
true = get ptr to first machine group, false = get ptr to first
operation group.
A pointer to the the first toolpath-type group, nullptr if none found.
Gets a list of operation IDs owned by the group with the given ID.
Identifier for the group.
True to also check child groups.
A list of operation IDs owned by the group with the given ID.
Sets the op_group.slot value in each group based on their position in the given list
of group IDs.
A list of group IDs in tree control order.
True if it succeeds, false if it fails.
Sort the underlying container in grpList by parent-child hierarchy, reset slot
numbers (op_group.slot).
[in,out] List of groups to sort.
first = true if group sort order is valid, second = true if sort order was updated,
third = true if slot numbers were updated.
Sort the underlying container in grpList by slot number (op_group.slot).
[in,out] List of groups to sort.
True if it succeeds, false if it fails.
Replaces the given group in our container.
The group to replace.
Null if it fails (or doesn't exist), else a pointer to a const op_group.
Import toolpath groups (excluding machine groups) from an external Mastercam file.
Filename of the Mastercam file.
List of group IDs in the source file to import.
Parent group ID from your current file to be assigned as the parent of the imported
groups.
True = update global Operation Manager, false = just add to container.
A map of old group IDs from the source file and their new group IDs in your current file.
Get a list of groups from external file.
The Mastercam source file to read from.
Type of the groups to return (GROUP_ALL, GROUP_OPERATIONS, etc).
(Optional) True to display debug warning if no groups are found.
List of groups.
Gets pairs of product codes and machine group pointers from the group list.
True = return unique pairs in std::vector, false = return all groups.
The product codes.
Gets the product mask combined from all our machine groups.
The product mask.
Sort the underlying vector in a TpGrpList by group types (geometry groups, toolpath
groups, etc) for 2022 and earlier version files.
[in,out] List of groups to sort.
Gets group names from a vector of group ptrs.
The group ptrs.
The group names.
Makes group name.
True if is machine group, false if not.
Name of the requested.
List of existing group names to prevent duplicates.
A CString.
Makes a unique, unused group name.
True if is machine group, false if not.
If not empty, the name we'd like to use if not already used.
(Optional) List of group pointers to check for an existing name,
nullptr = check global group list.
The next available group name.
Queries if a group with the given ID is a parent of a subgroup or toolpath operations.
Identifier for the group.
True if group is a parent of another or a toolpath operation, false if not.
Query if the group with the given ID or any of its parent groups are locked.
Identifier for the group.
True - check if any parent groups are locked, false - just check the subject group.
(Optional) True - check if any child groups are locked, false - just check the
subject group.
Return group ID of locked group (the subject ID or its locked parent), 0 = not locked.
Query if the group with the given ID or any of its parent groups are considered
'hidden'.
Identifier for the group.
(Optional) true - check if any parent groups are hidden, false -
just check the subject group.
Return group ID of hidden group (the subject ID or its hidden parent), 0 = not hidden.
Collect and return IDs from hidden toolpath groups and operations.
first = the hidden group IDs, second = operation IDs owned by the hidden groups.
Collect and return IDs from hidden toolpath groups and operations.
List of groups to look in.
List of operations to look in.
first = the hidden group IDs, second = operation IDs owned by the hidden groups.
Gets all the IDs of parent groups for the group with the given ID.
[in,out] List of groups.
Identifier for the group.
false = return list in parent-child order, true = return list in
proper deletion-order (child-parent order).
List of parent group IDs for the group with the given ID.
Gets all the IDs of child groups for the group with the given ID.
Identifier for the group.
false = return list in parent->child order, true = return list in
proper deletion-order (child->parent order).
List of parent group IDs for the group with the given ID.
Gets all the IDs of parent groups for the group with the given ID.
[in,out] List of groups.
Identifier for the group.
false = return list in parent-child order, true = return list in
proper deletion-order (child-parent order).
List of parent group IDs for the group with the given ID.
Gets all the IDs of parent groups for the group with the given ID.
Identifier for the group.
false = return list in parent-child order, true = return list in
proper deletion-order (child-parent order).
List of parent group IDs for the group with the given ID.
Query if group ID of 'suspectedParentId' is a parent of 'childId'.
Identifier for the suspected parent group.
Identifier for the child group.
True if suspectedParentId is a parent of childId, false if not.
Gets a list of group IDs for the given parents or children hierarchy.
[in,out] List of groups to look through.
Identifier for the subject group.
HierarchyDirection::Parents to collect IDs of parent groups,
HierarchyDirection::Children to collect IDs of child groups.
false = return list in parent->child order, true = return list in
proper deletion-order (child->parent order).
List of group IDs in hierarchy order.
Gets a list of group IDs for the given parents or children hierarchy.
Identifier for the subject group.
HierarchyDirection::Parents to collect IDs of parent groups,
HierarchyDirection::Children to collect IDs of child groups.
false = return list in parent->child order, true = return list in
proper deletion-order (child->parent order).
List of group IDs in hierarchy order.
Values that represent hierarchy directions for use in calls to GetHierarchy ().
Copies groups from source to target. Groups IDs may be reassigned if they conflict
with existing groups in the target list.
[in,out] TpGrpList to copy to.
Source list of groups to copy.
True to sort underlying container by slot number
(op_group.slot) after copying.
List of pairs (pointer to the newly added group, old group ID as its value may have
been reassigned as to not conflict with any existing groups.
Copies groups from source to target. Groups IDs may be reassigned if they conflict
with existing groups in the target list.
Source list of groups to copy.
True to sort underlying container by slot number
(op_group.slot) after copying.
List of pairs (pointer to the newly added group, old group ID as its value may have
been reassigned as to not conflict with any existing groups.
Gets the next unused, unique group ID.
List of groups to look through.
The next unused, unique group ID.
Gets the next unused, unique group ID.
The next unused, unique group ID.
Query if group with the given ID is the kind that contains a collection of operations that cannot be
deleted, edited or added to.
The ID of the group to check.
True if the group is a 'collection' group, false if not.
Query if group with the given ID is the last remaining machine or toolpath group.
List of groups.
The ID of the group to check.
True if last group, false if not.
Query if 'opGroup' is toolpath group (i.e. subgroup of a machine group).
The toolpath group to check.
True if a toolpath group, false if not.
Query if 'opGroup' is machine group.
The machine group to check.
True to check if machine pointer is not null.
True if machine group, false if not.
Query if 'grpList' is empty.
List of groups.
True if empty, false if not.
Query if this object is empty.
True if empty, false if not.
Deletes all toolpath groups.
[in,out] List of groups to delete.
true = only delete groups that are not referenced by toolpath
operations, false = delete all
.
Deletion parameters (delete machines attached to machine groups,
etc).
A set of group and subgroup IDs deleted.
Deletes all toolpath groups.
true = only delete groups that are not referenced by toolpath
operations, false = delete all
.
Deletion parameters (delete machines attached to machine groups,
etc).
A set of group and subgroup IDs deleted.
Deletes the group with the given ID.
[in,out] List of groups.
Identifier for the group.
true = only delete groups that are not referenced by toolpath
operations, false = delete all
.
Deletion parameters (delete machines attached to machine groups,
etc).
A set of group and subgroup IDs deleted.
Deletes the group with the given ID.
Identifier for the group.
true = only delete groups that are not referenced by toolpath
operations, false = delete all
.
Deletion parameters (delete machines attached to machine groups,
etc).
A set of group and subgroup IDs deleted.
Adds a group to the given list.
List of groups to add. Group IDs may be reassigned if they conflict with an existing
group.
(Optional) >0 = new parent group id OpMgr, else use op_group.parent_grp_idn.
List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to
not conflict with any existing groups.
Adds a group to the given list.
TpGrpList class to add groups to.
List of groups to add. Group IDs may be reassigned if they conflicts with exiting
groups in grpList.
(Optional) >0 = new parent group id OpMgr, else use op_group.parent_grp_idn.
List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to
not conflict with any existing groups.
Searches for the group considered 'active' in the OpMgr's tree control.
True to create a new machine and toolpath group if none found.
Pointer to the active group.
Gets a point to the root group of the group with the given ID.
[in,out] List of groups to look through.
Identifier for the group.
Pointer to the root group, nullptr if group not found.
Gets a point to the root group of the group with the given ID.
Identifier for the group.
Pointer to the root group, nullptr if group not found.
Gets the number of groups.
The number of groups.
Builds a map of group IDs and the IDs of operations that reference them.
A map of group IDs and the IDs of operations that reference them.
Gets a list of group IDs in slot number order.
The list of groups to look through.
A list of group IDs in slot number order.
Gets a set of group identifiers.
A set of group identifiers.
Gets copies of all the groups.
[in,out] List of groups to look through.
(Optional) The sorting method.
vector of groups.
Gets copies of all the groups.
(Optional) The sorting method.
vector of groups.
Builds and returns a list of const op_group * to all our groups.
[in,out] List of groups.
(Optional) The sorting method.
A list of const op_group * to all our groups.
Builds and returns a list of const op_group * to all our groups.
(Optional) The sorting method.
A list of const op_group * to all our groups.
Gets group pointers that pass the mask function.
The mask function.
(Optional) The sorting method.
vector of group pointers.
Returns a list of machine (root) group ptrs.
true = check if machine pointer in group is valid.
A list of machine (root) group ptrs.
Gets a point to the group with the given name in the given list (NOT case sensitive).
[in,out] List of groups to look through.
Name of the group.
Pointer to the group, nullptr if group not found.
Gets a point to the group with the given name (NOT case sensitive).
Name of the group.
Pointer to the group, nullptr if group not found.
Gets a point to the group with the given ID in the given list.
[in,out] List of groups to look through.
Identifier for the group.
Pointer to the group, nullptr if group not found.
Gets a point to the group with the given ID.
Identifier for the group.
Pointer to the group, nullptr if group not found.
Constructor.
True to enable all, false to disable all.
Default constructor.
Class for passing deletion parameters to DeleteExtraData()
Values that represent group sorting methods.
@par Purpose:
This virtual method override pops list objects off of the list stacks.
@return Returns true if the list objects were popped off the stacks correctly and false if not.
@par Purpose:
This virtual method override pushes new list objects onto the list stacks.
@return Returns true if new list objects were pushed onto the stacks correctly and false if not.
@par Purpose:
This is the default TpMatMgr destructor. It empties all of the list stacks upon destruction.
@par Purpose:
This is the default TpMatMgr constructor. It initializes the list stacks upon creation.
@par Purpose:
This virtual method empties all of the list stacks. This method is marked as private because
the list stacks should only be emptied when the manager gets destructed.
@return A boolean value indicating whether the emptying of the lists stacks was successful or not.
This is the manager class's main material list stack. This is where instances of our main material lists get stored.
@par Purpose:
This class's purpose is to hold and work with instances of the op manager material list classes for the life
of a given Mastercam app execution. It also houses the material list stacks themselves, which we use to manage
temporary list creation situations (see base TpMgr class declaration for more details).
@defgroup assocvar_ch15 nci line types
@{
@}
List Return Code types
@par Purpose:
This virtual method needs to be overridden in order to pop list objects off of the list stacks.
This needs to be handled in the derived classes because the base classes have no idea which list
stacks exist in the derived classes.
@return Should return true if the list objects were popped off the stacks correctly and false if not.
@par Purpose:
This virtual method needs to be overridden in order to push new list objects onto the list stacks.
This needs to be handled in the derived classes because the base classes have no idea which list
stacks exist in the derived classes.
@return Should return true if new list objects were pushed onto the stacks correctly and false if not.
@par Purpose:
This method returns the number of lists in each list stack.
@return The return value is the number of lists in the each list stack.
@par Purpose:
This is the basic TpMgr constructor. Note that the stack depth initializes to zero.
@par Purpose:
This virtual method needs to be overridden in order to empty out all of the list stacks. Since
only the derived classes actually know which lists exist in their class, that cleanup has to be
done on their end.
@return Should return true if the list stacks were emptied correctly and false if not.
This is a running tally of how many lists are on the stacks at any given time.
@par Purpose:
This class's purpose is to set up an interface for the managing of Mastercam's internal Op Manager lists.
The list objects are managed in stacks, which gives Mastercam some flexibility when it has to create new 'main'
lists for temporary purposes (temporary databases, file I/O, etc.). In those situations, the list stacks allow
us to push new, temporary list objects onto the stacks for use during the duration of the temporary situation.
Once no longer needed, we can then pop those temporary lists off the stacks and still be left with our original
lists still completely intact. This architecture removes the need to swap memory in and out for temporary lists
and still easily accomodates nested temporary list creation situations.
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.
The native instance to adapt.
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.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Gets the connections.
The connections.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Gets the current scope.
The current scope for temporary data, or null if there is none.
Creates a scope for temporary data to be added.
The new scope for temporary data.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Adds the given item to be used as temporary catalog data.
The item.
Constructor.
The native instance.
Constructor.
If non-null, the native instance.
A scope to be used to add temporary catalog data.
Constructor.
If non-null, the native instance.
Manager for temporary catalog data to be included as local data when building the UI catalog lists.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Gets the connections.
The connections.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Gets the current scope.
The current scope for temporary data, or null if there is none.
Creates a scope for temporary data to be added.
The new scope for temporary data.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Adds the given item to be used as temporary catalog data.
The item.
A scope to be used to add temporary catalog data.
Manager for temporary catalog data to be included as local data when building the UI catalog lists.
Gets the single instance of the ITempCatalogDataManager interface.
The single instance of the ITempCatalogDataManager interface.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Gets the connections.
The connections.
Gets the grades.
The grades.
Gets the manufacturers.
The manufacturers.
Gets the current scope.
The current scope for temporary data, or null if there is none.
Creates a scope for temporary data to be added.
The new scope for temporary data.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the given grade.
The grade.
True if it succeeds, false if it fails.
Updates the given manufacturer.
The manufacturer.
True if it succeeds, false if it fails.
Deletes the given tool grade.
The tool grade to delete.
True if it succeeds, false if it fails.
Deletes the given manufacturer.
The manufacturer to delete.
True if it succeeds, false if it fails.
Adds the given item to be used as temporary catalog data.
The item.
A scope to be used to add temporary catalog data.
Manager for temporary catalog data to be included as local data when building the UI catalog lists.
Adds a series of imported items to the specified library.
Only tool libraries are supported at this time.
Full pathname of the library file.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the part list in the machine group determined by the context from
which the importer was launched from.
Only mill tools and mill tool assemblies are supported at this time.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the context from which the importer was launched from.
The imported items.
True if it succeeds, false if it fails.
Gets the source operation identifier if importing into a toolpath operation.
The identifier of the source toolpath operation if importing into a toolpath operation context, or null
if not in the context of a toolpath.
Gets the logger.
A reference to an IToolDataImportLogger.
Constructor.
The native instance.
A tool data import Context adapter.
Gets the underlying native instance.
Gets the current operation tool.
Gets the name of the current workpiece material.
Gets the identifier of the current operation.
Constructor.
If non-null, the native instance.
A cutting data import context.
Gets the underlying native instance.
Gets the current operation tool.
Gets the name of the current workpiece material.
Gets the identifier of the current operation.
A cutting data import context.
Creates view of the given tool assembly with a new definition for the specified insert.
The assembly.
Identifier for the insert.
Identifier for the definition to insert the newly created definition after. A
value of GUID_NULL will insert at the end.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
The parent holder.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
Identifier for the holder.
The new view with new insert and definition or nullptr if unsuccessful.
Creates a 3d tool assembly with an insert and definition for the active machine group.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component above the specified component.
The assembly.
Identifier for the component to insert above.
The new view with new component or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component attached to the specified parent on the
specified connection.
The assembly.
Identifier for the parent.
Identifier for the connection on the parent.
The new view with new component or nullptr if unsuccessful.
Creates a lathe tool definition for the active machine group.
Options for controlling the operation.
The new definition for the active group.
Creates a new tool assembly insert based on an existing insert.
The other insert.
The new tool assembly insert.
Creates a new tool assembly insert.
Options for controlling the operation.
The new tool assembly insert.
Creates tool assembly adaptive item.
Options for controlling the operation.
The new tool assembly adaptive item.
Creates tool assembly turn holder.
Options for controlling the operation.
The new tool assembly turn holder.
Creates a holder assembly based on the passed in adaptive item.
The adaptive item.
The new holder assembly.
Creates a holder assembly based on the passed in turn holder.
The holder item.
The new holder assembly.
Creates a holder assembly.
Options for controlling the operation.
The new holder assembly.
Creates tool assembly instance for the active machine group.
True to create in metric.
The new tool assembly for active group.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
Factory service class providing functionality for creating bitmaps from tool components and assemblies.
Creates view of the given tool assembly with a new definition for the specified insert.
The assembly.
Identifier for the insert.
Identifier for the definition to insert the newly created definition after. A
value of GUID_NULL will insert at the end.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
The parent holder.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
Identifier for the holder.
The new view with new insert and definition or nullptr if unsuccessful.
Creates a 3d tool assembly with an insert and definition for the active machine group.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component above the specified component.
The assembly.
Identifier for the component to insert above.
The new view with new component or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component attached to the specified parent on the
specified connection.
The assembly.
Identifier for the parent.
Identifier for the connection on the parent.
The new view with new component or nullptr if unsuccessful.
Creates a lathe tool definition for the active machine group.
Options for controlling the operation.
The new definition for the active group.
Creates a new tool assembly insert based on an existing insert.
The other insert.
The new tool assembly insert.
Creates a new tool assembly insert.
Options for controlling the operation.
The new tool assembly insert.
Creates tool assembly adaptive item.
Options for controlling the operation.
The new tool assembly adaptive item.
Creates tool assembly turn holder.
Options for controlling the operation.
The new tool assembly turn holder.
Creates a holder assembly based on the passed in adaptive item.
The adaptive item.
The new holder assembly.
Creates a holder assembly based on the passed in turn holder.
The holder item.
The new holder assembly.
Creates a holder assembly.
Options for controlling the operation.
The new holder assembly.
Creates tool assembly instance for the active machine group.
True to create in metric.
The new tool assembly for active group.
The tool number.
True to create the tool in metric units.
The type.
Parameters used to create cutting definitions when building 3d tool assemblies.
True to create the tool in metric units.
The type.
Parameters used to create inserts when building 3d tool assemblies.
True to create the tool in metric units.
Parameters used to create holders when building 3d tool assemblies.
A tool interface instance factory.
Creates an instance of the ITlToolAssemblyFactory interface.
The new ITlToolAssemblyFactory instance.
Creates a new tool assembly and lathe definition from the specified holder and insert.
The holder.
The insert.
(Optional) Name of the holder connection to attach the insert onto. Default
behavior will add a new connection onto the holder.
The new tool assembly and definition from holder and insert.
Creates view of the given tool assembly with a new definition for the specified insert.
The assembly.
Identifier for the insert.
Identifier for the definition to insert the newly created definition after. A
value of GUID_NULL will insert at the end.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
The parent holder.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new insert and definition.
The assembly.
Identifier for the holder to add the insert to.
The new view with new insert and definition or nullptr if unsuccessful.
Creates a 3d tool assembly with an insert and definition for the active machine group.
Options for controlling the operation.
The new view with new insert and definition or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component above the specified component.
The assembly.
Identifier for the component to insert above.
The new view with new component or nullptr if unsuccessful.
Creates view of the given tool assembly with a new component attached to the specified parent on the
specified connection.
The assembly.
Identifier for the parent.
Identifier for the connection on the parent.
The new view with new component or nullptr if unsuccessful.
Creates a lathe tool definition for the active machine group.
Options for controlling the operation.
The new definition for the active group.
Creates a new tool assembly insert based on an existing insert.
The other insert.
The new tool assembly insert.
Creates a new tool assembly insert.
Options for controlling the operation.
The new tool assembly insert.
Creates tool assembly adaptive item.
(Optional) True to create in metric.
The new tool assembly adaptive item.
Creates tool assembly turn holder.
Options for controlling the operation.
The new tool assembly turn holder.
Creates a holder assembly based on the passed in adaptive item.
The adaptive item.
The new holder assembly.
Creates a holder assembly based on the passed in turn holder.
The holder item.
The new holder assembly.
Creates a holder assembly.
(Optional) True to create in metric.
The new holder assembly.
Creates tool assembly instance for the active machine group.
(Optional) True to create in metric.
The new tool assembly for active group.
Parameters used to create definitions when building 3d tool assemblies.
Parameters used to create inserts when building 3d tool assemblies.
Parameters used to create holders when building 3d tool assemblies.
A factory service for use when creating instances of TlToolAssembly and related types for the purpose of
building and working with 3d tools.
Array indexer operator.
Parameterized constructor.
The double to process.
The double to process.
The double to process.
The double to process.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TransformationMatrixColumn tool class type.
Density
Hardness Value
Hardness Unit
ISO Value
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlWorkMaterial tool class type.
Image File Path
Group Identifier
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolType tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolSlotMill tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolReamer tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolLatheISO tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolGroup tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolFeedMill tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolEndmill tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolCounterBore tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolCenterDrill tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolBoring tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolDrill tool class 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.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolBarrelMill tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlInsertTurningBoring tool class type.
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)
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlInsertThreading tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlInsertGrooving tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolemakingOpParams tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheThreading tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheLiveCenter tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheGrooving tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheBoring tool class type.
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.
Gets or sets the 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.
Gets or sets the rough depth of cut.
Gets or sets the 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.
Gets or sets the stock clearance.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCuttingConfigurationGrooving tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCutParam tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyAdaptiveItem tool class type.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
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 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.
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 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.
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 the hardness for scale.
The scale.
The hardness for scale.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
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 query to find out if 'other' is equal.
The other.
true if equal, false if not.
The tool type ids.
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.
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.
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.
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.
Gets the tool type ids.
The tool type ids.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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 corner radius.
The corner radius.
Gets program radius.
The program radius.
Gets program radius.
The program radius.
Gets tapered height.
The tapered height.
Gets tapered height.
The tapered height.
Sets operation tool information.
The information.
Sets operation tool information.
The information.
Gets operation tool information.
The operation tool information.
Gets operation tool information.
The operation tool information.
Default constructor.
Default constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result 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.
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.
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.
Default Constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result 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.
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.
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.
Default Constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result 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.
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.
Sets corner radius.
The value.
Gets corner radius.
The corner radius.
Gets corner radius.
The corner radius.
Sets operation tool information.
The information.
Sets operation tool information.
The information.
Gets operation tool information.
The operation tool information.
Gets operation tool information.
The operation tool information.
Default constructor.
Default constructor.
Turns an arc into a set of lines.
arc to linearize.
(Optional) The chordal deviation tolerance.
a set of lines.
Turns an arc into a set of lines.
arc to linearize.
(Optional) The chordal deviation tolerance.
a set of lines.
Normalizes the arc to avoid bizarre construction. Should be called whenever arc is set
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 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.
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.
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
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 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 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.
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.
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.
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.
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.
Transforms the given transformation.
The transformation.
Type of the transform.
Validates the quadrant.
true if it succeeds, false if it fails.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
Reverses the segment.
Gets maximum width.
The maximum width.
Gets maximum width.
The maximum width.
Gets top width using just the endpoints of the arc.
The top 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.
Gets bottom width using just the endpoints of the arc.
The bottom width.
Height of segment
said height
Height of segment
said height
Gets the length of this profile segment.
The length.
Gets the length of this profile segment.
The length.
Query if this object is convex.
true if convex, false if not.
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 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.
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 end endpoint of this segment.
The end endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Lowest point contained in segment
Lowest point contained in segment
Lowest point contained in segment
Lowest point contained in segment
Maximum x coordinate.
A double.
Maximum x coordinate.
A double.
Highest point contained in segment
Highest point contained in segment
Highest point contained in segment
Highest point contained in segment
Maximum x coordinate.
A double.
Maximum x coordinate.
A double.
Conversion function
(Optional) The chordal deviation tolerance.
vector of TlProfileLineSegmentPtr representing this object, linearized
Conversion function
(Optional) The chordal deviation tolerance.
vector of TlProfileLineSegmentPtr representing this object, linearized
Assignment operator.
The right hand side of the assignment operation.
A deep copy of this object.
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 center x coordinate.
The center y coordinate.
The radius.
The start angle.
The sweep angle.
The color.
Constructor.
The segment.
The color.
Constructor.
The segment.
The color.
Copy constructor.
The other.
Copy constructor.
The other.
Default constructor.
Default constructor.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
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 convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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 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 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 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 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.
Sets a grade.
The grade.
true if it succeeds, false if it fails.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Gets a const pointer to the adaptive item.
The pointer to the adaptive item, or nullptr if not valid.
Gets a const pointer to the adaptive item.
The pointer to the adaptive item, or nullptr if not valid.
Stepover Finish Z
Stepover Finish XY
Stepover Rough Z
Stepover Rough XY
Finish Flag
Rough Flag
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlMillingOpParams tool class type.
Cleans up the clearance circles.
Draws clearance circles for the specified tool assembly view.
The tool assembly.
The definition slot to draw the clearance circles for.
Cleans up the tool boundaries.
Draws the boundaries for the specified tool assembly view.
The tool assembly.
The definition slot.
Cleanup connection plane gnomon.
Draw connection plane gnomon.
The tool assembly.
Identifier for the connection on the component tree.
Cleans up all graphics managed by this engine.
Gets the solids data.
A reference to an IDesignerSolidsData.
Builds the solids.
The tool assembly.
True if it succeeds, false if it fails.
Cleanups the given designer data.
Constructor.
The native instance.
A tool designer graphics engine adapter.
Cleans up the clearance circles.
Draws clearance circles for the specified tool assembly view.
The tool assembly.
The definition slot to draw the clearance circles for.
Cleans up the tool boundaries.
Draws the boundaries for the specified tool assembly view.
The tool assembly.
The definition slot.
Cleanup connection plane gnomon.
Draw connection plane gnomon.
The tool assembly.
Identifier for the connection on the component tree.
Cleans up all graphics managed by this engine.
Gets the solids data.
A reference to an IDesignerSolidsData.
Builds the solids.
The tool assembly.
True if it succeeds, false if it fails.
Cleanups the given designer data.
A tool designer graphics engine.
Creates a new instance of the IToolDesignerGraphicsEngine interface.
The new IToolDesignerGraphicsEngine interface instance.
Cleans up the clearance circles.
Draws clearance circles for the specified tool assembly view.
The tool assembly.
The definition slot to draw the clearance circles for.
Cleans up the tool boundaries.
Draws the boundaries for the specified tool assembly view.
The tool assembly.
The definition slot.
Cleanup connection plane gnomon.
Draw connection plane gnomon.
The tool assembly.
Identifier for the connection on the component tree.
Cleans up all graphics managed by this engine.
Gets the solids data.
A reference to a const IDesignerSolidsData.
Gets the solids data.
A reference to an IDesignerSolidsData.
Builds the solids.
The tool assembly.
True if it succeeds, false if it fails.
Cleanups the given designer data.
A tool designer graphics engine.
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
Gets or sets the Number 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.
Gets or sets the Pull Off
Sets FinishPassAllowance property in the specified units.
value to set.
true to specify value is in metric.
Gets FinishPassAllowance property in the specified units.
true to get value in metric.
TheFinishPassAllowance property.
Gets or sets the Finish Pass 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.
Gets or sets the 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.
Gets or sets the First Depth Of Cut
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCuttingConfigurationThreading tool class type.
A cutting configuration threading deserialization implementation.
A cutting configuration threading deserialization implementation.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
An add tools to group applet.
The tools to add.
Parameters for configuring this applet.
The tools to add.
Parameters for configuring this applet.
(Immutable) the callback to be invoked when items have been completed.
Options for controlling the adding of the tools.
Parameters for configuring this applet.
List of identifiers for the items added as part of the applet's execution.
The results to be sent back when this applet runs.
An add tools to group applet.
Gets the single instance of the IAddToolsToGroupApplet::Factory interface instance.
The reference to the IAddToolsToGroupApplet::Factory interface instance.
Parameters for configuring this applet.
The results to be sent back when this applet runs.
An add tools to group applet.
Values that represent focus behaviors.
Parameters used for editing an existing tool assembly instance.
Values that represent focus behaviors .
Parameters used for editing an existing tool instance.
Parameters used for creating a new tool instance.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ICreateToolAssemblyApplet managed adapter implementation.
(Immutable) the on tool assembly committed callback.
Options for controlling the adding of the tool assembly to the group.
Options for controlling the creation of the tool assembly.
A create machine group mill tool assembly parameters.
A create tool assembly applet.
Gets the single instance of the ICreateToolAssemblyApplet::Factory interface instance.
The reference to the ICreateToolAssemblyApplet::Factory interface instance.
Parameters for configuring this applet.
A create tool assembly applet.
Import the contents from the specified file into the specified context.
Full pathname of the file to import.
The context to import data through.
True if it succeeds, false if it fails.
Launches the user interface operation for this importer.
The context from which it has been launched.
Handle of the parent.
True if it succeeds, false if it fails.
Queries the importer on whether or not it will provide a interface for the user. If an interface is not
provided, and an interface is desired, a value of 'false' should be returned. Mastercam will supply
an interface in this case when one is supported.
True to put the responsibility for any user interaction within this importer. False to let Mastercam
handle the user interface responsibility.
Retrieves a set of possible file types that can be imported by this importer.
The import file types.
Retrieves the localized name of this tool data importer.
The name.
Gets client instance.
Nullptr if it fails, else the client instance.
Constructor.
If non-null, the client importer to direct to.
A tool data importer adapter.
Gets an importer associated to the specified identifier .
Identifier for the importer.
Nullptr if it fails, else the importer.
Removes the importer described by importerId.
If non-null, identifier for the importer.
Adds an importer to be managed by this manager and associated to the specified identifier. .
Identifier for the importer.
If non-null, the importer.
True if it succeeds, false if it fails.
Adds an importer to be managed by this manager. Importers are associated to the GUID sent back as a
result.
The tool data importer.
A System::Guid to associate to the supplied importer.
Constructor.
The native instance to adapt.
A tool data importer manager adapter.
Gets an importer associated to the specified identifier .
Identifier for the importer.
Nullptr if it fails, else the importer.
Removes the importer described by importerId.
If non-null, identifier for the importer.
Adds an importer to be managed by this manager and associated to the specified identifier. .
Identifier for the importer.
If non-null, the importer.
True if it succeeds, false if it fails.
Adds an importer to be managed by this manager. Importers are associated to the GUID sent back as a
result.
The tool data importer.
A System::Guid to associate to the supplied importer.
Manager for the set of tool data importers provided as import options in the classic tool manager lists.
Manufacturer Identifier
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolGrade tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolMaterial tool class type.
Sets a commercial name.
The name.
true if it succeeds, false if it fails.
Gets the commercial name.
The commercial name.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlMaterial tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlOpParams tool class type.
The KYOCERA SGS id.
The KYOCERA SGS id.
The Haas id.
The Haas id.
The Tungaloy id.
The Tungaloy id.
The Mikron id.
The Mikron id.
The Precision Cutting Tools id.
The Precision Cutting Tools id.
The Walter id.
The Walter id.
The Benchmark Carbide id.
The Benchmark Carbide id.
The Hitachi id.
The Hitachi id.
The Voha Tosec id.
The Voha Tosec id.
The Valor Holemaking id.
The Valor Holemaking id.
The IMCO Carbide id.
The IMCO Carbide id.
The Heli-Coli id.
The Heli-Coli id.
The us union tool id.
The us union tool id.
The hpi id.
The hpi id.
The mari tool id.
The mari tool id.
The lyndex nikken id.
The lyndex nikken id.
The yg id.
The yg id.
The fraisa id.
The fraisa id.
The redline id.
The redline id.
The micro 100 id.
The micro 100 id.
The harvey tool id.
The harvey tool id.
The garr id.
The garr id.
The everede id.
The everede id.
The ma ford id.
The ma ford id.
The emuge id.
The emuge id.
The osg id.
The osg id.
The mitsubishi id.
The mitsubishi id.
The Helical ID.
The Helical ID.
The Holex - Hoffman Group ID.
The Holex - Hoffman Group ID.
The Garant - Hoffman Group ID.
The Garant - Hoffman Group ID.
The Sumitomo ID.
The Sumitomo ID.
The Onsrud ID.
The Onsrud ID.
The Harvey ID.
The Harvey ID.
The Greenleaf ID.
The Greenleaf ID.
The Vortex ID.
The Vortex ID.
The Walter-Valenite ID.
The Walter-Valenite ID.
The Widia-Hanita ID.
The Widia-Hanita ID.
The Seco ID.
The Seco ID.
The Dapra ID.
The Dapra ID.
The Duramill ID.
The Duramill ID.
The Niagara ID.
The Niagara ID.
The Dataflute ID.
The Dataflute ID.
The Millstar ID.
The Millstar ID.
The Intersoll ID.
The Intersoll ID.
The Robbjack ID.
The Robbjack ID.
The Sandvik ID.
The Sandvik ID.
The Kennemetal ID.
The Kennemetal ID.
The Command Tool ID.
The Command Tool ID.
The mastercam id.
The mastercam id.
The iscar id.
The iscar id.
Static Constructor.
Static Constructor.
Makes a deep copy of this object.
nullptr if it fails, else a 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.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Default Constructor.
Defines the TlManufacturer tool class type.
Defines the TlManufacturer tool class type.
A deserialization implementation.
A deserialization implementation.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Executes the get default cutting side operation.
A TlCuttingSide.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
A deserialization implementation.
A deserialization implementation.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Executes the get default cutting side operation.
A TlCuttingSide.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
A deserialization implementation.
A deserialization implementation.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Executes the get default cutting side operation.
A TlCuttingSide.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
A deserialization implementation.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
Default constructor.
Declaration of private deserialization implementation class.
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.
Executes the is similar operation.
The sp other.
Identifier for the machine group.
The compare mode.
true if it succeeds, false if it fails.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
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.
Default Constructor.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
Gets holemaking operation parameters.
The holemaking operation parameters.
Default constructor.
Default constructor.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
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.
Executes the is similar operation.
The sp other.
Identifier for the machine group.
The compare mode.
true if it succeeds, false if it fails.
Executes the is similar operation.
The sp other.
Identifier for the machine group.
The compare mode.
true if it succeeds, false if it fails.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Gets milling operation parameters.
The milling operation parameters.
Gets milling operation parameters.
The milling operation parameters.
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.
Sets the radius type.
The radius.
Sets the radius type.
The radius.
Sets the radius type.
The radius.
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.
Gets the radius type.
The radius type.
Gets the radius type.
The radius type.
Sets the corner radius.
The corner radius.
Sets the corner radius.
The corner radius.
Sets the corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Gets 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.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Gets operation tool information.
The operation tool information.
Gets operation tool information.
The operation tool information.
Gets operation tool information.
The operation tool information.
Default constructor.
Default constructor.
Default constructor.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result 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.
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.
Sets the radius type.
Type of the radius.
true if it succeeds, false if it fails.
Gets the corner type.
The corner type.
Gets the corner type.
The corner type.
Gets operation tool information.
The operation tool information.
Gets operation tool information.
The operation tool information.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Sets an operation tool information.
The information.
true if it succeeds, false if it fails.
Declaration of private deserialization implementation class.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result 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.
Given two holders, returns two if they are identical, false otherwise.
A reference to the first holder.
A reference to the second holder.
True if it succeeds, false if it fails.
Given two holders, returns two if they are identical, false otherwise.
A reference to the first holder.
A reference to the second holder.
True if it succeeds, false if it fails.
Given new data to store in the holder, attaches all the data and setups up the holder correctly.
The IDN of the holder to modify.
Source for the holder data.
true if it succeeds, false if it fails.
Given new data to store in the holder, attaches all the data and setups up the holder correctly.
The IDN of the holder to modify.
Source for the holder data.
true if it succeeds, false if it fails.
Given new data to store in the holder, attaches all the data and setups up the holder correctly.
The IDN of the holder to modify.
Pointer to the segment data for the holder.
The total size of holderData.
Pointer to the library name.
The number of characters in the library name.
Pointer to the holder name.
The number of characters in the holder name.
True if it succeeds, false if it fails.
Given new data to store in the holder, attaches all the data and setups up the holder correctly.
The IDN of the holder to modify.
Pointer to the segment data for the holder.
The total size of holderData.
Pointer to the library name.
The number of characters in the library name.
Pointer to the holder name.
The number of characters in the holder name.
True if it succeeds, false if it fails.
Given an ent_idn, returns true if the holder exists, false otherwise.
The holder idn.
true is the holder exists, false otherwise.
Given an ent_idn, returns true if the holder exists, false otherwise.
The holder idn.
true is the holder exists, false otherwise.
Given a ent_idn, retrieves the tp_holder for this holder.
For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in
particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at
holderEntity.u.holder.holder_ptr)
The holder idn.
The holder.
true if a matching holder entity was found, false otherwise.
Given a ent_idn, retrieves the tp_holder for this holder.
For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in
particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at
holderEntity.u.holder.holder_ptr)
The holder idn.
The holder.
true if a matching holder entity was found, false otherwise.
Given a ent_idn, retrieves the entity for this holder.
For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in
particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at
holderEntity.u.holder.holder_ptr)
The holder idn.
The holder entity.
true if a matching holder entity was found, false otherwise.
Given a ent_idn, retrieves the entity for this holder.
For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in
particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at
holderEntity.u.holder.holder_ptr)
The holder idn.
The holder entity.
true if a matching holder entity was found, false otherwise.
Creates a new holder entity and stores it in the database.
Source for the holder data.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
Source for the holder data.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
Source for the holder data.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
Source for the holder data.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
The 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.
Creates a new holder entity and stores it in the database.
The library name to initialize this holder with.
The length of the holder_lib string.
The name of the holder.
The length of the holder_name string.
The ent_idn of the newly-created holder.
Sets the number of segements for the holder and creates the needed memory to store the segments.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The number of segments this holder has.
True if it succeeds, false if it fails.
Sets the number of segements for the holder and creates the needed memory to store the segments.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The number of segments this holder has.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The new holder name as a CString.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The new holder name as a CString.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new holder name.
The number of characters in the holder name.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new holder name.
The number of characters in the holder name.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The library name as a CString.
True if it succeeds, false if it fails.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The library name as a CString.
True if it succeeds, false if it fails.
Sets the library name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new library name.
The number of characters in the library name.
True if it succeeds, false if it fails.
Sets the library name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new library name.
The number of characters in the library name.
True if it succeeds, false if it fails.
Creates a local copy of the holder entity at the specified IDN.
The holder idn.
A holder allocation that cleans itself up on destruction or std::nullopt if there is no database holder.
Creates a local copy of the holder entity at the specified IDN.
The holder idn.
A holder allocation that cleans itself up on destruction or std::nullopt if there is no database holder.
Creates a new holder with COPIES of the old holder data in the database.
The IDN of the database holder to copy.
The new entity IDN in the database.
Creates a new holder with COPIES of the old holder data in the database.
The IDN of the database holder to copy.
The new entity IDN in the database.
Creates a legacy tp_holder allocation from the given holder segments, library name, and holder name.
The segments.
Name of the library.
Name of the holder.
The new holder allocation.
Creates a copy of the specified holder.
The holder to copy.
Information describing the segment.
Size of the segment data.
Name of the library.
Size of the library name.
Name of the holder.
Size of the holder name.
The new holder allocation copy.
Creates a copy of the specified holder.
The holder to copy.
The new holder allocation copy.
Allocate new memory for the given holder.
The holder.
Size of the buffer.
The allocator.
Allocate new memory for the given holder.
The holder.
The allocator.
Gets buffer size for the specified holder instance.
The holder.
The buffer size.
A tp_holder allocation for use in managing legacy tool holders and their variable length memory.
Gets or sets a flag indicating whether the machine connection plane has been set on the component yet.
Gets the identifier of the component on the tree.
Gets the component tree.
Constructor.
The native instance.
A component designer data adapter.
Gets or sets a flag indicating whether the machine connection plane has been set on the component yet.
Gets the identifier of the component on the tree.
Gets the component tree.
An interface representing the data and states of the 3D Tool and Holder Assembly Component Designers.
Creates a new instance of the IComponentDesignerData interface.
The component tree to modify with the designer.
Identifier for the component to be modified by the designer.
True if the designer is being used to create a component, false if not.
The new IComponentDesignerData interface instance.
Gets a flag indicating whether the machine connection plane has been set on the component yet.
True if the component's machine connection plane has been set, false if not.
Gets a flag indicating whether the machine connection plane has been set on the component yet.
True if the component's machine connection plane has been set, false if not.
Component identifier.
A reference to a const GUID.
Component tree.
A reference to a const TlAssemblyComponentTree.
Component tree.
A reference to a TlAssemblyComponentTree.
An interface representing the data and states of the 3D Tool and Holder Assembly Component Designers.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheTurning tool class 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.
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.
Deletes the solids.
Clears the highlighting.
Highlight solids for component item.
Identifier for the component item.
Sets the visibility (blanked) state of the solids not associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids.
True to show, false to hide.
Calculates the extents of the solids marked as cutting or non cutting.
The minimum extents.
The maximum extents.
True to measure the cutting solids, false for non cutting.
Calculates the extents of the solids.
The minimum extents.
The maximum extents.
Transform the solids by the specified transformation matrix.
The matrix.
Searches for the component item identifier mapped to the specified solid entity pointer.
The eptr.
The component item id mapped to the specified eptr if found, nullptr if not.
Gets or sets the view that the solids were built in.
Adds the specified solid eptr as associated to the specified component item.
The eptr.
Identifier for the component item.
True if the specified component is a cutting component, false if not.
Gets the solids that are not for the specified component item.
Identifier for the component item.
The solids not marked as for the specified component item.
Gets the solids for the specified component item.
Identifier for the component item.
The solids marked as for the specified component item.
Gets the solids.
Constructor.
A designer solids data adapter.
Deletes the solids.
Transform the solids by the specified transformation matrix.
The matrix.
Gets or sets the view that the solids were built in.
Adds the specified solid entity pointer as associated to the specified component item.
The solid entity pointer to add.
Identifier for the component item.
True if the specified component is a cutting component, false if not.
An interface representing the solids data of a designer applet.
Clears the highlighting.
Highlight solids for component item.
Identifier for the component item.
Sets the visibility (blanked) state of the solids not associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids associated to the specified component item.
Identifier for the component item.
True to show, false to hide.
Sets the visibility (blanked) state of the solids.
True to show, false to hide.
Calculates the extents of the solids marked as cutting or non cutting.
The minimum extents.
The maximum extents.
True to measure the cutting solids, false for non cutting.
Calculates the extents of the solids.
The minimum extents.
The maximum extents.
Searches for the component item identifier mapped to the specified solid entity pointer.
The solid entity pointer.
The component item id mapped to the specified eptr if found, nullptr if not.
Gets the view that the solids were built in.
Gets the solids that are not for the specified component item.
Identifier for the component item.
The solids not marked as for the specified component item.
Gets the solids for the specified component item.
Identifier for the component item.
The solids marked as for the specified component item.
Gets the solids.
An interface representing the solids data of a designer applet.
Gets or sets the cutting plane center point.
Gets or sets the active designer tab.
Gets or sets a value indicating whether the cutting plane has been defined.
Gets or sets a value indicating whether the compensation point has been defined.
Gets a value indicating whether this instance has been configured for creating a new definition.
Gets the tool assembly view.
Constructor.
The native instance.
A tool designer insert and definition data.
Gets or sets the cutting plane center point.
Gets or sets the active designer tab.
An enum constant representing the parameters tab option option.
An enum constant representing the compensation tab option.
An enum constant representing the machine tab option.
An enum constant representing the boundary tab option.
An enum constant representing the setup tab option.
An enum constant representing the mating tab option.
An enum constant representing the cutting definition tab option.
An enum constant representing the insert tab option.
Values that represent active designer tabs.
Gets or sets a value indicating whether the cutting plane has been defined.
Gets or sets a value indicating whether the compensation point has been defined.
Gets a value indicating whether this instance has been configured for creating a new definition.
Gets the tool assembly view.
A tool designer insert and definition data.
Creates a new instance of the IToolDesignerInsertAndDefinitionData interface.
The tool assembly view.
True to initialize the data for creating, false for editing.
The new IToolDesignerInsertAndDefinitionData interface instance.
Cutting plane center point.
A p_3d.
Cutting plane center point.
A p_3d representing the cutting plane's center point.
Gets access to the active tab flag.
A value indicating what tab the designer is currently on.
Gets access to the active tab flag.
A reference to a DesignerTab indicating what tab the designer is currently on.
Values that represent active designer tabs.
Determines if the cutting plane has been defined.
True if the cutting plane has been defined, false if not.
Gets access to the cutting plane defined flag.
A reference to the cutting plane defined flag.
Determines if the compensation point has been defined.
True if the compensation point has been defined, false if not.
Gets access to the compensation point defined flag.
A reference to the compensation point defined flag.
Determines if we are creating a new definition.
True if it succeeds, false if it fails.
Gets the tool assembly view.
A reference to a const TlToolAssemblyLatheDefView.
Gets the tool assembly view.
A reference to a TlToolAssemblyLatheDefView.
A tool designer insert and definition data.
Calculates the tool angle from plunge angle.
The plunge angle.
The assembly view.
The calculated tool angle from plunge angle.
Calculates the tool angle from feed angle.
The feed angle.
The assembly view.
The calculated tool angle from feed angle.
Generates boundaries for the tool assembly view.
Information describing the designer.
Information describing the designer solids.
The current extents 2D translation applied to the solids.
The minimum model extents.
The maximum model extents.
The result of the generation process.
Updates the boundary plane offsets from boundary planes.
The assembly view.
The first boundary plane.
The second boundary plane.
Initializes the boundary planes from assembly.
The first boundary plane.
The second boundary plane.
The assembly view.
Initializes the boundary plane offsets from the given model extents.
The extents are expected to be from the assembly's models with the cutting plane set to top view.
The assembly view.
The minimum extents.
The maximum extents.
Invert boundary plane offsets as needed.
The assembly view.
The insert up states before changes.
The insert up states after changes.
Collect the assembly's insert up down states.
The tool assembly.
A map of assembly insert id to insert up down state.
Inverts the cutting plane up direction on the specified tool assembly view.
Not applicable for inserts defined for Y-Axis cutting.
The assembly view.
Applies the specified cutting plane scalar offset to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, if the insert represented by the assembly view is the primary insert of
the tool assembly, the offset will be applied relative to the tool axis. For non-primary inserts, the
offset will be applied as relative to the primary insert's cutting plane center. For Y-Axis tools,
the offset is defined as the distance from the tool assembly machine connection plane center along
the tool axis.
The cutting plane scalar offset value to apply.
The designer data.
Gets the cutting plane scalar offset for the specified tool assembly.
The assembly view.
The cutting plane scalar offset.
Gets a transformation matrix defining the starting angle transformation displayed when the rotation angle
selection applet is run.
The assembly view.
The tool assembly view transform.
The cutting plane rotation angle selection applet transform.
Applies the specified cutting plane rotation angle to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, the rotation angle will be applied as relative to the primary insert's
cutting plane normal about the tool axis. For Y-Axis tools, the rotation angle is defined as the
rotation angle difference between the machine connection plane's reference axis and the cutting
plane's reference axis. For non-primary Y-Axis inserts, the angle is defined as relative to the
primary insert's normal if not defined for Y-Axis turning or its reference axis if it is defined for
Y-Axis turning.
The cutting plane rotation angle value to apply.
The assembly view.
Gets the cutting plane rotation angle for the specified tool assembly.
The assembly view.
The cutting plane rotation angle.
Determine if we can define a cutting plane rotation angle.
The assembly view.
True if we can define a cutting plane rotation angle, false if not.
Applies a new cutting plane to the specified tool assembly view that was selected via a named plane.
The new cutting plane to set.
The tool assembly view transformation (to be removed from the cutting plane).
The designer data.
Applies a new cutting plane to the specified tool assembly view that was selected from a solid face.
The new cutting plane to set.
The tool assembly view transformation (to be removed from the cutting plane).
The designer data.
Determine if we can allow for user selection of a cutting plane.
Cutting planes can be selected for primary inserts that have not been defined for Y-Axis turning.
The assembly view.
True if we can a select cutting plane, false if not.
Constructor.
The sp native instance.
An interface providing the functional capabilities of the 3D Tool and Holder Assembly Component Designers.
Calculates the tool angle from plunge angle.
The plunge angle.
The assembly view.
The calculated tool angle from plunge angle.
Calculates the tool angle from feed angle.
The feed angle.
The assembly view.
The calculated tool angle from feed angle.
Generates boundaries for the tool assembly view.
Information describing the designer.
Information describing the designer solids.
The current extents 2D translation applied to the solids.
The minimum model extents.
The maximum model extents.
The result of the generation process.
Updates the boundary plane offsets from boundary planes.
The assembly view.
The first boundary plane.
The second boundary plane.
Initializes the boundary planes from assembly.
The first boundary plane.
The second boundary plane.
The assembly view.
Initializes the boundary plane offsets from the given model extents.
The extents are expected to be from the assembly's models with the cutting plane set to top view.
The assembly view.
The minimum extents.
The maximum extents.
Invert boundary plane offsets as needed.
The assembly view.
The insert up states before changes.
The insert up states after changes.
Collect the assembly's insert up down states.
The tool assembly.
A map of assembly insert id to insert up down state.
Inverts the cutting plane up direction on the specified tool assembly view.
Not applicable for inserts defined for Y-Axis cutting.
The assembly view.
Applies the specified cutting plane scalar offset to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, if the insert represented by the assembly view is the primary insert of
the tool assembly, the offset will be applied relative to the tool axis. For non-primary inserts, the
offset will be applied as relative to the primary insert's cutting plane center. For Y-Axis tools,
the offset is defined as the distance from the tool assembly machine connection plane center along
the tool axis.
The cutting plane scalar offset value to apply.
The designer data.
Gets the cutting plane scalar offset for the specified tool assembly.
The assembly view.
The cutting plane scalar offset.
Gets a transformation matrix defining the starting angle transformation displayed when the rotation angle
selection applet is run.
The assembly view.
The tool assembly view transform.
The cutting plane rotation angle selection applet transform.
Applies the specified cutting plane rotation angle to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, the rotation angle will be applied as relative to the primary insert's
cutting plane normal about the tool axis. For Y-Axis tools, the rotation angle is defined as the
rotation angle difference between the machine connection plane's reference axis and the cutting
plane's reference axis. For non-primary Y-Axis inserts, the angle is defined as relative to the
primary insert's normal if not defined for Y-Axis turning or its reference axis if it is defined for
Y-Axis turning.
The cutting plane rotation angle value to apply.
The assembly view.
Gets the cutting plane rotation angle for the specified tool assembly.
The assembly view.
The cutting plane rotation angle.
Determine if we can define a cutting plane rotation angle.
The assembly view.
True if we can define a cutting plane rotation angle, false if not.
Applies a new cutting plane to the specified tool assembly view that was selected via a named plane.
The new cutting plane to set.
The tool assembly view transformation (to be removed from the cutting plane).
The designer data.
Applies a new cutting plane to the specified tool assembly view that was selected from a solid face.
The new cutting plane to set.
The tool assembly view transformation (to be removed from the cutting plane).
The designer data.
Determine if we can allow for user selection of a cutting plane.
Cutting planes can be selected for primary inserts that have not been defined for Y-Axis turning.
The assembly view.
True if we can a select cutting plane, false if not.
A 3d tool designer insert and definition applet engine.
Creates a new instance of the IToolDesignerInsertAndDefinitionEngine interface.
The new IToolDesignerInsertAndDefinitionEngine interface instance.
Sets insert type to threading.
[in,out] Information describing the designer.
True if it succeeds, false if it fails.
Sets insert type to grooving.
[in,out] Information describing the designer.
True if it succeeds, false if it fails.
Sets insert type to turning.
[in,out] Information describing the designer.
True if it succeeds, false if it fails.
Sets compensation point from arc.
[in,out] Information describing the designer.
The arc.
The current extent transform.
True if it succeeds, false if it fails.
Populates a component point from cut profile.
[in,out] Information describing the designer.
The cut profile.
The corner radius.
The current extent transform.
True if it succeeds, false if it fails.
Sets component point transform from the provided point. If the current compensation point is not set, the difference of 'currentExtentTransform' and 'compPoint' will form the translation.
[in,out] Information describing the designer.
The component point.
The current extent transform point.
True if it succeeds, false if it fails.
Sets compensation quadrant from orientation.
[in,out] The lathe definition view.
True if it succeeds, false if it fails.
Sets feed speed of the TlToolAssemblyLatheDefView object from the passed in material object.
[in,out] The assembly view.
The material.
True if it succeeds, false if it fails.
Sets the passed in IToolDesignerInsertAndDefinitionData insert and associated information from the passed in TlInsert object.
[in,out] Information describing the designer.
The insert.
True if it succeeds, false if it fails.
Sets mounting angle from line.
[in,out] Information describing the designer.
The first line.
True if is from plunge, false if not.
Sets clearance angle from line.
[in,out] Information describing the designer.
The first line.
True if modifying Clearance Side Angle, False if modifying Clearance End Angle.
True if it succeeds, false if it fails.
Sets clearance from two arcs.
[in,out] Information describing the designer.
The first arc.
The second arc.
True if modifying Clearance Width, False if modifying Clearance Height.
True if it succeeds, false if it fails.
Sets clearance from arc and point.
[in,out] Information describing the designer.
The first arc.
The first point.
True if modifying Clearance Width, False if modifying Clearance Height.
True if it succeeds, false if it fails.
Sets clearance from two points.
[in,out] Information describing the designer.
The first point.
The second point.
True if modifying Clearance Width, False if modifying Clearance Height.
True if it succeeds, false if it fails.
Calculates the tool angle from plunge angle.
The plunge angle.
The assembly view.
The calculated tool angle from plunge angle.
Calculates the tool angle from feed angle.
The feed angle.
The assembly view.
The calculated tool angle from feed angle.
Generates boundaries for the tool assembly view.
Information describing the designer.
Information describing the designer solids.
The current extents 2D translation applied to the solids.
The minimum model extents.
The maximum model extents.
The result of the generation process.
Updates the boundary plane offsets from boundary planes.
The assembly view.
The first boundary plane.
The second boundary plane.
Initializes the boundary planes from assembly.
The first boundary plane.
The second boundary plane.
The assembly view.
Initializes the boundary plane offsets from the given model extents.
The extents are expected to be from the assembly's models with the cutting plane set to top view.
The assembly view.
The minimum extents.
The maximum extents.
Invert boundary plane offsets as needed.
The assembly view.
The insert up states before changes.
The insert up states after changes.
Collect the assembly's insert up down states.
The tool assembly.
A map of assembly insert id to insert up down state.
Inverts the cutting plane up direction on the specified tool assembly view.
Not applicable for inserts defined for Y-Axis cutting.
The assembly view.
Applies the specified cutting plane scalar offset to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, if the insert represented by the assembly view is the primary insert of
the tool assembly, the offset will be applied relative to the tool axis. For non-primary inserts, the
offset will be applied as relative to the primary insert's cutting plane center. For Y-Axis tools,
the offset is defined as the distance from the tool assembly machine connection plane center along
the tool axis.
The cutting plane scalar offset value to apply.
The data.
Gets the cutting plane scalar offset for the specified tool assembly.
The assembly view.
The cutting plane scalar offset.
Gets a transformation matrix defining the starting angle transformation displayed when the rotation angle
selection applet is run.
The assembly view.
The tool assembly view transform.
The cutting plane rotation angle selection applet transform.
Applies the specified cutting plane rotation angle to the cutting plane defined by the specified tool
assembly view.
For conventional turning tools, the rotation angle will be applied as relative to the primary insert's
cutting plane normal about the tool axis. For Y-Axis tools, the rotation angle is defined as the
rotation angle difference between the machine connection plane's reference axis and the cutting
plane's reference axis. For non-primary Y-Axis inserts, the angle is defined as relative to the
primary insert's normal if not defined for Y-Axis turning or its reference axis if it is defined for
Y-Axis turning.
The cutting plane rotation angle value to apply.
The assembly view.
Gets the cutting plane rotation angle for the specified tool assembly.
The assembly view.
The cutting plane rotation angle.
Determine if we can define a cutting plane rotation angle.
The assembly view.
True if we can define a cutting plane rotation angle, false if not.
Applies the cutting plane from named plane.
The cutting plane.
The tool assembly view transform.
[in,out] Information describing the designer.
Applies a new cutting plane to the specified tool assembly view that was selected from a solid face.
The new cutting plane to set.
The tool assembly view transformation (to be removed from the cutting plane).
[in,out] Information describing the designer.
Determine if we can allow for user selection of a cutting plane.
Cutting planes can be selected for primary inserts that have not been defined for Y-Axis turning.
The assembly view.
True if we can a select cutting plane, false if not.
A 3d tool designer insert and definition applet engine.
Gets the type of the tool.
True to use custom type, meaning that if custom, the specialization will be
returned (Drill, Groove, etc.).
True to flag custom, meaning that if custom, the custom specialization types will
be used (CustomDrilling, CustomTurning, etc.).
The type.
Gets the type of the tool.
TheThe type.
Resets the identifiers.
Creates a description of this tool.
The offset number.
The new description.
Creates a description of this tool.
The new description.
Lathe tooling cutting parameters for defining what the parameters in a toolpath will default to if requested.
An interface into lathe tooling compensation parameters, or null if not valid for the tool type.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the ILTool interface.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates an icon for the given item
The item.
The size.
A bitmap instance.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates a a icon for the given assembly.
The assembly.
The size.
A bitmap instance.
Creates an icon for the given holder.
The holder.
The icon size.
A bitmap instance
Creates a icon for the given holder assembly.
The holder assembly.
The icon size.
A bitmap instance.
Creates a icon for the given adaptive item.
The adaptive item.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
Options for controlling the operation.
A bitmap instance.
Creates a icon for the given item.
The tool slot. Only lathe tool slots are supported at this time.
Options for controlling the operation.
A bitmap instance.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
Factory service class providing functionality for creating bitmaps from tool components and assemblies.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates an icon for the given item
The item.
The size.
A bitmap instance.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates a a icon for the given assembly.
The assembly.
The size.
A bitmap instance.
Creates an icon for the given holder.
The holder.
The icon size.
A bitmap instance
Creates a icon for the given holder assembly.
The holder assembly.
The icon size.
A bitmap instance.
Creates a icon for the given adaptive item.
The adaptive item.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
The icon size.
A bitmap image source.
Creates a bitmap image source for the given item.
The item.
The icon size.
A bitmap image source.
Creates a bitmap image source for the given item.
The item.
Options for controlling the operation.
A bitmap image source.
Creates a bitmap image source for the lathe tool at the given slot.
The tool slot. Only lathe tool slots are supported at this time.
Options for controlling the operation.
A bitmap image source.
Value indicating whether to mark the tool image as the machine group display tool or not.
Value indicating whether to create the tool image in black in white or not.
True to use a transparent background. Pixels matching the given background color will be made fully transparent.
The background color.
Identifier for the current operation.
True to show in the image if the tool is used.
The image size.
A parameters set used for controlling the creation of a tool bitmap.
An enum constant representing the setup sheet size option.
An enum constant representing the huge size option.
An enum constant representing the extra large size option.
An enum constant representing the large size option.
An enum constant representing the medium size option.
An enum constant representing the small size option.
An enum constant representing the original option.
Values that represent bitmap sizes.
Factory service class providing functionality for creating bitmaps from tool components and assemblies.
Creates an instance of the tool class bitmap factory interface.
The new tool class bitmap factory instance.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates an icon for the given item
The item.
The size.
A bitmap instance.
Creates a icon for the given item.
The item.
The tool params.
A bitmap instance.
Creates a a icon for the given assembly.
The assembly.
The size.
A bitmap instance.
Creates an icon for the given holder.
The holder.
The icon size.
A bitmap instance
Creates a icon for the given holder assembly.
The holder assembly.
The icon size.
A bitmap instance.
Creates a icon for the given adaptive item.
The adaptive item.
The icon size.
A bitmap instance.
Creates a icon for the given turn holder.
The turn holder.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
The icon size.
A bitmap instance.
Creates a icon for the given item.
The item.
Options for controlling the operation.
A bitmap instance.
Creates a icon for the given item.
The tool slot. Only lathe tool slots are supported at this time.
Options for controlling the operation.
A bitmap instance.
Creates a new icon for the specified graphics file. Must be an image file.
The image.
The size.
A bitmap instance.
A parameters set used for controlling the creation of a tool bitmap.
Values that represent sizes.
A tool bitmap factory interface.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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 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.
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.
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.
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.
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.
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.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
Reverses the segment.
Gets maximum width.
The maximum width.
Gets maximum width.
The maximum width.
Gets top width.
The top width.
Gets top width.
The top width.
Gets bottom width.
The bottom width.
Gets bottom width.
The bottom width.
Height of segment
said height
Height of segment
said height
Gets the length of this profile segment.
The length.
Gets the length of this profile segment.
The length.
Gets the end endpoint of this segment.
The end endpoint.
Gets the end endpoint of this segment.
The end endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Lowest point contained in segment
Lowest point contained in segment
Lowest point contained in segment
Lowest point contained in segment
Minimum x coordinate.
A double.
Minimum x coordinate.
A double.
Highest point contained in segment
Highest point contained in segment
Highest point contained in segment
Highest point contained in segment
Maximum x coordinate.
A double.
Maximum x coordinate.
A double.
Conversion function.
(Optional) The chordal deviation tolerance.
vector of TlProfileLineSegmentPtr representing this object, linearized.
Conversion function.
(Optional) The chordal deviation tolerance.
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 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.
Constructor.
The segment.
The color.
Default constructor.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Constructor.
A Point2D to process.
A double to process.
The start angle.
The sweep angle.
Sweep angle in radians.
Start angle in radians.
Arc radius.
Centerpoint.
Arc2D.
Defines the TlProfileArcSegment tool class type.
Constructor.
The endpoint 1 x coordinate.
The endpoint 1 y coordinate.
The endpoint 2 x coordinate.
The endpoint 2 y coordinate.
The color.
Line
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Constructor.
The first x value.
The first y value.
The second x value.
The second y value.
Constructor.
The end point 1.
The end point 2.
The second endpoint.
The first endpoint.
Line2D.
Defines the TlProfileLineSegment tool class type.
Deletes the entities.
Sets the visibility (blanked) state of the wireframe.
True to show, false to hide.
Sets cutting color.
The color.
Transform the wireframe entities by the specified transformation matrix.
The matrix.
Gets or sets the view that the wireframe was built in.
Gets the non cutting entities.
The non cutting entities.
Gets the cutting entities.
The cutting entities.
Gets the entities.
Adds the specified wireframe entity pointer as a cutting or non cutting piece of geometry.
The wireframe entity pointer.
True if is cutting, false if not.
Constructor.
If non-null, the native instance.
A designer wireframe data adapter.
Deletes the entities.
Transform the wireframe entities by the specified transformation matrix.
The matrix.
Gets or sets the view that the wireframe was built in.
Adds the specified wireframe entity pointer as a cutting or non cutting piece of geometry.
The wireframe entity pointer.
True if is cutting, false if not.
An interface representing the wireframe data of a designer applet.
Sets the visibility (blanked) state of the wireframe.
True to show, false to hide.
Sets cutting color.
The color.
Gets the view that the wireframe was built in.
Gets the non cutting entities.
The non cutting entities.
Gets the cutting entities.
The cutting entities.
Gets the entities.
An interface representing the wireframe data of a designer applet.
Deletes the entities.
Sets the visibility (blanked) state of the wireframe.
True to show, false to hide.
Sets cutting color.
The color.
Transform the wireframe entities by the specified transformation matrix.
The matrix.
Gets the view that the wireframe was built in.
A reference to a const CM::Transform3D.
Gets the view that the wireframe was built in.
A reference to a const CM::Transform3D.
Gets the non cutting entities.
The non cutting entities.
Gets the cutting entities.
The cutting entities.
Gets the entities.
The entities.
Adds the specified wireframe eptr as a cutting or non cutting piece of geometry.
The eptr.
True if is cutting, false if not.
A designer wireframe data.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLatheDrill tool class type.
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
Tool Type
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderLathe tool class 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.
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.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the ILToolThreadCutParams interface.
Sets the MaxhreadPitch property in the specified units.
value to set.
true to specify value is in metric.
Gets the MaxThreadPitch property in the specified units.
true to get value in metric.
The MaxThreadPitch property.
Gets or sets the maximum thread pitch.
Sets the MinThreadPitch property in the specified units.
value to set.
true to specify value is in metric.
Gets the MinThreadPitch property in the specified units.
true to get value in metric.
The MinThreadPitch property.
Gets or sets the minimum thread pitch.
Gets or sets the number of spring cuts.
Sets the PullOff property in the specified units.
value to set.
true to specify value is in metric.
Gets the PullOff property in the specified units.
true to get value in metric.
The PullOff property.
Gets or sets the pull off.
Sets the FinishPassAllowance property in the specified units.
value to set.
true to specify value is in metric.
Gets the FinishPassAllowance property in the specified units.
true to get value in metric.
The FinishPassAllowance property.
Gets or sets the finish pass allowance.
Sets the LastDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the LastDepthOfCut property in the specified units.
true to get value in metric.
The LastDepthOfCut property.
Gets or sets the last depth of cut.
Sets the FirstDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the FirstDepthOfCut property in the specified units.
true to get value in metric.
The FirstDepthOfCut property.
Gets or sets the first depth of cut.
An interface representing lathe threading tool cutting parameters.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the ILToolGrooveCutParams interface.
Sets the FinishDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the FinishDepthOfCut property in the specified units.
true to get value in metric.
The FinishDepthOfCut property.
Gets or sets the finish depth of cut.
Sets the RoughDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the RoughDepthOfCut property in the specified units.
true to get value in metric.
The RoughDepthOfCut property.
Gets or sets the rough depth of cut.
Gets or sets the backoff percentage.
Sets the StockClearance property in the specified units.
value to set.
true to specify value is in metric.
Gets the StockClearance property in the specified units.
true to get value in metric.
The StockClearance property.
Gets or sets the stock clearance.
An interface representing lathe grooving tool cutting parameters.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the ILToolTurnBoreCutParams interface.
Sets the FacingXOvercutAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets the FacingXOvercutAmount property in the specified units.
true to get value in metric.
The FacingXOvercutAmount property.
Gets or sets the facing X overcut amount.
Sets the FacingRetractionAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets the FacingRetractionAmount property in the specified units.
true to get value in metric.
The FacingRetractionAmount property.
Gets or sets the facing retraction amount.
Sets the RoughOverlapAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets the RoughOverlapAmount property in the specified units.
true to get value in metric.
The RoughOverlapAmount property.
Gets or sets the rough overlap amount.
Sets the FinishDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the FinishDepthOfCut property in the specified units.
true to get value in metric.
The FinishDepthOfCut property.
Gets or sets the finish depth of cut.
Sets the RoughDepthOfCut property in the specified units.
value to set.
true to specify value is in metric.
Gets the RoughDepthOfCut property in the specified units.
true to get value in metric.
The RoughDepthOfCut property.
Gets or sets the rough depth of cut.
An interface representing lathe turning boring tool cutting parameters.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the ILToolDrillCutParams interface.
Gets or sets the drill cycle.
Gets or sets the Dwell Amount.
Sets the Retract property in the specified units.
value to set.
true to specify value is in metric.
Gets the Retract property in the specified units.
true to get value in metric.
The Retract property.
Gets or sets the Retraction Amount.
Sets the PeckClearance property in the specified units.
value to set.
true to specify value is in metric.
Gets the PeckClearance property in the specified units.
true to get value in metric.
The PeckClearance property.
Gets or sets the Peck clearance.
Sets the Peck2 property in the specified units.
value to set.
true to specify value is in metric.
Gets the Peck2 property in the specified units.
true to get value in metric.
The Peck2 property.
Gets or sets the second Peck.
Sets the Peck1 property in the specified units.
value to set.
true to specify value is in metric.
Gets the Peck1 property in the specified units.
true to get value in metric.
The Peck1 property.
Gets or sets the first Peck.
An interface representing lathe drilling tool cutting parameters.
Sets the local tool assembly view.
The tool view.
Gets the local tool assembly view.
The tool assembly view.
Gets the offset value from the machine tool axis to the cutting plane of the tool.
The machine tool axis cut plane offset.
Sets the compensation quadrant.
The value.
Loads holder model.
If non-null, full pathname of the model file.
True if it succeeds, false if it fails.
Loads insert model.
If non-null, full pathname of the model file.
True if it succeeds, false if it fails.
Gets the type of the tool.
True to use custom type, meaning that if custom, the specialization will be
returned (Drill, Groove, etc.).
True to flag custom, meaning that if custom, the custom specialization types will
be used (CustomDrilling, CustomTurning, etc.).
The type.
Gets the type of the tool.
TheThe type.
Resets the identifiers.
Creates a description of this tool.
The offset number.
The new description.
Creates a description of this tool.
The new description.
Lathe tooling cutting parameters for defining what the parameters in a toolpath will default to if requested.
An interface into lathe tooling compensation parameters, or null if not valid for the tool type.
Finalizer.
Destructor.
Constructor.
The native instance to adapt.
An adapter class for the I3dLTool interface.
Gets the offset value from the machine tool axis to the cutting plane of the tool.
The machine tool axis cut plane offset.
Sets the compensation quadrant.
The value.
Loads holder model.
If non-null, full pathname of the model file.
True if it succeeds, false if it fails.
Loads insert model.
If non-null, full pathname of the model file.
True if it succeeds, false if it fails.
Sets the local tool assembly view.
The tool view.
Gets the local tool assembly view.
The tool assembly view.
Gets or sets the type of the tool assembly.
The type of the tool assembly.
Sets CompPoint property in the specified units.
value to set.
true to specify value is in metric.
Gets CompPoint property in the specified units.
true to get value in metric.
The CompPointX property.
Compensation Point Coordinates
Sets NonCutProfile property in the specified units.
value to set.
true to specify value is in metric.
Gets the NonCutProfile property in the specified units.
True to get value in metric.
The CutProfile property.
Gets the cutting boundary for the tool.
The cutting plane.
Sets CutProfile property in the specified units.
value to set.
true to specify value is in metric.
Gets the CutProfile property in the specified units.
True to get value in metric.
The CutProfile property.
Gets the cutting boundary for the tool.
The cutting plane.
Sets CuttingPlane property in the specified units.
value to set.
true to specify value is in metric.
Gets the CuttingPlane property in the specified units.
True to get value in metric.
The CuttingPlane property.
Gets the cutting plane transformation.
The cutting plane transformation is the transformation required to rotate and translate the 3d solids of the tool
from the orientation they are in at when the machine connection plane is facing Y+ at Y = 0 to the position where
the cutting plane is facing Z+ at Z = 0.
The cutting plane.
Sets MachineConnectionPlane property in the specified units.
value to set.
true to specify value is in metric.
Gets the MachineConnectionPlane property in the specified units.
True to get value in metric.
The MachineConnectionPlane property.
Gets the machine connection plane transformation.
The machine connection plane transformation is the required transformation to move the 3D solid for the holder
into a position such that the normal of the plane is defined as {0.0, 1.0, 0.0}
and the origin of the plane is at the origin (0.0, 0.0, 0.0). If the model for the holder is defined such that it
is already correctly placed on the origin, a rotation may still be required so that the intended plane's face has
the correct normal vector.
The machine side connection plane.
Sets InsertPosition property in the specified units.
value to set.
true to specify value is in metric.
Gets the InsertPosition property in the specified units.
True to get value in metric.
The InsertPosition property.
Gets the insert connection transformation.
The insert connection transformation is the required transformation to move the 3D solid defined for the insert
into relative position with the 3D solid defined for the holder. If the solid for the insert is already defined
with respect to the holder solid, this transformation should be the identity matrix.
The insert position.
Gets a value indicating whether the insert has a model.
Gets a value indicating whether the insert has a model.
An enum constant representing the multi function option.
An enum constant representing the parting option.
An enum constant representing the face grooving option.
An enum constant representing the external grooving option.
An enum constant representing the internal grooving option.
An enum constant representing the external threading option.
An enum constant representing the internal threading option.
An enum constant representing the boring bar option.
An enum constant representing the turning option.
Values that represent tool assembly types.
Interface for a 3D lathe tool.
Values that represent spindle speed units.
Values that represent feed rate units.
Values that represent materials.
Sets the local tool assembly view.
The tool view.
Gets the local tool assembly view.
The tool assembly view.
Values that represent tool assembly types.
Gets the cutting plane rotation offset angle between the primary insert cutting plane and the active
insert cutting plane for this tool assembly.
The rotation angle offset between the cutting planes of the primary insert and current insert.
Gets the offset in z-depth between the primary insert cutting plane and the active insert cutting plane
for this tool assembly.
The z-depth scalar offset between the cutting planes of the primary insert and current insert.
Gets the offset value from the machine tool axis to the cutting plane of the tool.
The machine tool axis cut plane offset.
Sets the compensation quadrant.
The value.
Loads holder model.
Full pathname of the file.
True if it succeeds, false if it fails.
Loads holder model.
Full pathname of the file.
True if it succeeds, false if it fails.
Makes a deep copy of this object.
A copy of this object.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The IUpdateMachineGroupToolApplet managed adapter implementation.
(Immutable) the on tool committed callback.
Options for controlling behavior of updating the edited assembly.
The updated tool assembly.
A create machine group mill tool parameters.
An update machine group tool applet.
The behavior to invoke if the tool is used by toolpath operations and the prompt is suppressed.
True to suppress the duplicate tool number warning.
True to prompt the user when the tool is used by toolpath operations.
True if updating from operation parameters - the current operation (cur_op) will be considered when prompting the user and updating operations.
An enum constant representing the cancel changes option.
An enum constant representing the create new tool option.
An enum constant representing the update all toolpath operations option.
Values that represent update toolpath operations modes.
An update machine group tool parameters.
The default tool type to start with when designing the tool.
A create mill tool parameters.
True to suppress, false to allow the duplicate tool number warning that occurs when the machine group says so.
True to append "Copy of" to the tool assembly name if similar tools exist.
True to add if similar tools exist and the user warning was suppressed.
True to issue a warning if similar tools exist in the machine group.
True to initialize tool offsets.
Identifier for the machine group (std::nullopt to use the globally active machine group).
An add tool assembly to machine group parameters.
Gets the single instance of the IUpdateMachineGroupToolApplet::Factory interface instance.
The reference to the IUpdateMachineGroupToolApplet::Factory interface instance.
Parameters for configuring this applet.
An update machine group tool applet.
Values that represent update toolpath operations modes.
An update machine group tool parameters.
An add tool assembly to machine group parameters.
Imports cutting data using the specified import context.
The cutting data import context.
Handle of the parent window should UI be required.
Determines if this importer supports importing turning cutting data.
Determines if this importer supports importing milling cutting data.
Retrieves the localized name of this tool data importer.
Constructor.
If non-null, the native instance.
A cutting data importer.
Imports cutting data using the specified import context.
The cutting data import context.
Handle of the parent window should UI be required.
Determines if this importer supports importing turning cutting data.
True if this importer supports turning cutting data, false if not.
Determines if this importer supports importing milling cutting data.
True if this importer supports milling cutting data, false if not.
Retrieves the localized name of this tool data importer.
The name.
Gets client instance.
Nullptr if it fails, else the client instance.
Constructor.
If non-null, the client importer to direct to.
A cutting data importer native wrapper.
Imports cutting data using the specified import context.
The cutting data import context.
Handle of the parent window should UI be required.
Determines if this importer supports importing turning cutting data.
Determines if this importer supports importing milling cutting data.
Retrieves the localized name of this tool data importer.
A cutting data importer.
Gets an importer associated to the specified identifier .
Identifier for the importer.
Nullptr if it fails, else the importer.
Removes the importer described by importerId.
If non-null, identifier for the importer.
Adds an importer to be managed by this manager and associated to the specified identifier. .
Identifier for the importer.
If non-null, the importer.
True if it succeeds, false if it fails.
Adds an importer to be managed by this manager. Importers are associated to the GUID sent back as a
result.
The cutting data importer.
A System::Guid to associate to the supplied importer.
Constructor.
The native instance to adapt.
A cutting data importer manager adapter.
Gets an importer associated to the specified identifier .
Identifier for the importer.
Nullptr if it fails, else the importer.
Removes the importer described by importerId.
If non-null, identifier for the importer.
Adds an importer to be managed by this manager and associated to the specified identifier.
Identifier for the importer.
If non-null, the importer.
True if it succeeds, false if it fails.
Adds an importer to be managed by this manager. Importers are associated to the GUID sent back as a
result.
The cutting data importer.
A System::Guid to associate to the supplied importer.
Manager for the set of cutting data importers provided as options in the toolpath tool lists.
Gets the single instance of the ICuttingDataImporterManager interface.
The ICuttingDataImporterManager single instance.
Imports cutting data using the specified import context.
The cutting data import context.
Handle of the parent window should UI be required.
Determines if this importer supports importing turning cutting data.
True if this importer supports turning cutting data, false if not.
Determines if this importer supports importing milling cutting data.
True if this importer supports milling cutting data, false if not.
A cutting data importer.
Use the provided action to apply changes to the current operation.
Changing non-cutting parameters such as identifiers or types will have undefined behavior and potentially
negative consequences.
The action.
Gets the current operation tool.
The current operation tool.
Gets the current operation.
The current operation.
Gets the current workpiece material.
The current workpiece material.
A cutting data import context.
Gets or sets a value indicating whether this adaptive item is an extension
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAdaptiveItem tool class type.
Gets or sets whether the holder assembly is metric
Tests if Image reference property is set.
true if Image is set, false if not.
Gets or sets the image for the holder assembly
Gets or sets the assembly component tree
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderAssembly tool class type.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolLatheCustom tool class type.
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 (Coolant 0x0008-off, 0x0010-Flood, 0x0020-Mist, 0x0040-Through-tool)
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCoolant tool class type.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Gets the root item pointer.
The root item pointer.
Gets insert item identifiers.
The insert item identifiers.
Gets all identifiers of the assembly items contained within this component tree.
The item identifiers.
Gets a collection of pointers to the turn holders defined on this tree.
The turn holders.
Updates the projection length adjustment described by value.
Identifier for the component.
The value.
True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
Identifier for the component.
True to get value in metric.
The projection length adjustment.
Updates the item model data.
Identifier for the component.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Applies the given transform to the parent connection.
Identifier for the component.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
Identifier for the component.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Removes the workpiece side connection.
Identifier for the component.
Identifier for the connection.
True if it succeeds, false if it fails.
Adds a workpiece side connection to the component described by 'componentId'.
Identifier for the component.
The connection.
True if it succeeds, false if it fails.
Gets the connections.
The connections.
Gets component workpiece side connection map pointer.
Identifier for the component.
Null if it fails, else the component workpiece side connection map pointer.
Gets component machine side connection pointer.
Identifier for the component.
Null if it fails, else the component machine side connection pointer.
Gets a const pointer to the connection described by connectionId.
Identifier for the connection.
Null if it fails, else the connection.
Gets the connection for the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert connection.
Gets a const pointer to the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert.
Gets a sorted list of the identifiers of all assembly insert components currently in this tree.
The sorted list of assembly insert identifiers.
Gets a collection of const pointers to the inserts defined on this tree.
The inserts.
Attempts to add the given component onto the workpiece connection specified by the given identifier
provided that the specified connection exists and that there is not already a component on it.
Identifier for the workpiece-side connection.
The new component.
True if it succeeds, false if it fails.
Attempts to insert the given component in the tree above the component specified by the given identifier.
Identifier for the component to add above.
The new component to add.
True if it succeeds, false if it fails.
Duplicates the component in the tree with the specified identifier.
Identifier for the component.
The ID of the new component if successful, or GUID_NULL if not.
Deletes the component and all children described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Deletes the component described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Updates the item in the component in the tree described by componentId.
Identifier for the component.
The item.
True if it succeeds, false if it fails.
Updates the component in the tree described by component.
The component.
True if it succeeds, false if it fails.
Gets a pointer to the component that is attached to the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer attached to connection.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Query if there is a component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Gets component item identifier.
Identifier for the component.
The component item identifier.
Gets a pointer to the assembly item contained within the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component item pointer.
Gets a pointer to the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component pointer.
Gets the components in the tree.
The components.
Gets a pointer to the machine side connection of the component tree.
The machine side connection pointer.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets the tool assembly pointer.
The tool assembly pointer.
Tests if Root reference property is set.
true if Root is set, false if not.
Gets or sets the root assembly component on this component tree.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyComponentTree tool class type.
The native pointer to the proxy containing the native shared pointer instance.
Flag indicating whether this instance has been disposed.
Updates the projection length adjustment described by value.
The value.
True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
True to get value in metric.
The projection length adjustment.
Updates the item model data.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Updates the underlying assembly item with the given value.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the underlying assembly item.
Null if it fails, else the item pointer.
Updates the component described by value.
The value.
True if it succeeds, false if it fails.
Gets component pointer.
Null if it fails, else the component pointer.
Applies the given transform to the parent connection.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform described by xform.
The updated transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Query if there is a child component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Removes the workpiece side connection described by value.
The connection identifier.
True if it succeeds, false if it fails.
Updates the connection described by value.
The value.
Adds a workpiece side connection to this component.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the map of workpiece side connections for this component.
Null if it fails, else the workpiece side connections.
Gets the parent connection pointer.
Null if it fails, else the parent connection pointer.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Gets item identifier.
The item identifier.
Gets component identifier.
The component identifier.
Sets the assembly.
The value.
Gets the assembly.
The assembly.
Gets native object pointer.
The native object pointer.
Finaliser.
Destructor.
Constructor to create a view of the 3D tool assembly for a specific assembly component.
The assembly.
Identifier for the assembly component.
Constructor to create a view of the 3D tool assembly in machine position.
The assembly.
Constructor to create a view of the 3D tool assembly in machine position.
An owning native pointer to a proxy wrapper around a shared pointer to a native instance.
A specific assembly component view of a TlToolAssembly instance.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlConnectionMap tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolderComposite tool class type.
The children.
The Insertion.
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.
Gets the children of this item.
The children.
Sets a holder.
The holder.
Gets the holder.
The holder.
Adds a child.
The child.
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.
Defines a composite holder tree node.
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.
Accessory items for this holder
Lower Connection Type
Lower Connection Size
Upper Connection Type
Upper Connection Size
Holder Type
Library Name
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlHolder tool class type.
The height.
Width of the bottom.
Width of the top.
A tl holder segment.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TransformationMatrix tool class type.
Generates wireframe for the tool.
The tool.
A Result.
Generates the wireframe for the lathe definition view.
The lathe definition view.
A Result.
Generates the wireframe for the tool assembly.
The tool assembly.
A map container slot numbers and their wireframe results.
A wireframe generator for use with 3d tool assemblies.
The total boundary validation result code.
The non-cutting boundary result code.
The cutting boundary result code.
Encapsulates the result of generating wireframe.
Values that represent wireframe generator result codes.
An enum constant representing the boundaries do not touch option.
An enum constant representing a failure to generate an offset contour of the boundary.
An enum constant representing a failure to find the outer boundary of the generated boundary.
An enum constant representing a failure to generate a silhouette boundary.
An enum constant representing a failure to create a construction plane.
An enum constant representing a failure because of there being no solids given to generate a boundary from.
An enum constant representing the no error option.
Calculates the profile.
The profile calculation parameters.
The profile result.
Tl profile builder interface class.
The type of profile parameters required to calculate a profile.
A localized error message describing the error if the result is not valid..
The profile.
The result code.
Encapsulates the result of the construction of a profile.
Values that represent possible profile calculation result states.
An enum constant representing the unknown error option.
An enum constant representing the illegal chamfer distance option.
An enum constant representing the custom tool file line on Y axis error option.
An enum constant representing the custom tool file allocation error option.
An enum constant representing the custom tool file multiple boundaries option.
An enum constant representing the custom tool file items not processed option.
An enum constant representing the custom tool file unable to break arc option.
An enum constant representing the custom tool file lines and arcs only option.
An enum constant representing the custom tool file arc too small option.
An enum constant representing the custom tool file line too small option.
An enum constant representing the custom tool file arc not in view one option.
An enum constant representing the custom tool file line not in view one option.
An enum constant representing the custom tool file pocket boundaries not closed option.
An enum constant representing the custom tool file cut no cut levels equal option.
An enum constant representing the custom tool file no cut level not found option.
An enum constant representing the custom tool file cut level not found option.
An enum constant representing the custom tool file no profile entities option.
An enum constant representing the custom tool problem with file or data option.
An enum constant representing the illegal thickness shoulder lengths option.
An enum constant representing the illegal thickness option.
An enum constant representing the edge break distance too large for diameter option.
An enum constant representing the relief angle non zero with invalid diameters option.
An enum constant representing the invalid relief taper angle option.
An enum constant representing the invalid upper taper angle option.
An enum constant representing the invalid lower taper angle option.
An enum constant representing the upper radius too large option.
An enum constant representing the lower radius too large option.
An enum constant representing the profile radius too large option.
An enum constant representing the profile radius too small option.
An enum constant representing the chamfer distance too large for diameter option.
An enum constant representing the thread pitch too large for diameter option.
An enum constant representing the shoulder diameter larger than tool diameter option.
An enum constant representing the lower radius larger than profile radius option.
An enum constant representing the no neck length option.
An enum constant representing the reduced neck larger than shoulder shank option.
An enum constant representing the illegal reduced neck radius option.
An enum constant representing the taper zero shank and shoulder different option.
An enum constant representing the shoulder diameter larger than shank option.
An enum constant representing the shoulder diameter cant be zero option.
An enum constant representing the tapered section zero length on tapered tool option.
An enum constant representing the tool shorter than sum of components option.
An enum constant representing the shoulder diameter larger than arbor option.
An enum constant representing the check taper angle option.
An enum constant representing the taper angle or flute length error option.
An enum constant representing the tool length too short option.
An enum constant representing the check corner radius arbor diameter option.
An enum constant representing the no tip angle allowed option.
An enum constant representing the tool diameter equals arbor diameter option.
An enum constant representing the check corner radius option.
An enum constant representing the tip diameter exceeds tool diameter option.
An enum constant representing the shoulder length too short for diameter option.
An enum constant representing the tool length too short for diameter option.
An enum constant representing the shoulder angle too steep option.
An enum constant representing the tip angle too steep option.
An enum constant representing the corner radius or flute length error option.
An enum constant representing the arbor diameter too large option.
An enum constant representing the tip tool diameter intersection error option.
An enum constant representing the arbor radius exceeds tool radius option.
An enum constant representing the illegal corner radius option.
An enum constant representing the corner radius too large for radius option.
An enum constant representing the shoulder length corner radians error option.
An enum constant representing the tool length corner radians error option.
An enum constant representing the illegal flute shoulder lengths option.
An enum constant representing the illegal arbor diameter option.
An enum constant representing the illegal flute length option.
An enum constant representing the illegal shoulder length option.
An enum constant representing the illegal tool length option.
An enum constant representing the illegal tool diameter option.
An enum constant representing the no error option.
Get a CM::Transform3D describing the given Mastercam plane.
Plane from which to extract the transformation matrix.
Plane transform.
Get a CM::Transform3D describing the Mastercam Plane matrix.
The PlaneId.
Plane transform.
Get a CM::Transform3D describing the current Mastercam view plane.
View plane transform.
Get a CM::Transform3D describing the current Mastercam WCS matrix plane.
WCS plane transform.
Get a CM::Transform3D describing the current Mastercam tool plane.
Tool plane transform.
Get a CM::Transform3D describing the current Mastercam construction plane.
(Optional) Optional flag to apply construction depth.
Construction plane transform.
Get a CM::Transform3D describing a Mastercam style matrix and origin.
The view matrix.
(Optional) The origin.
A CM::Transform3D.
Get a CM::Transform3D describing a Mastercam Planes style matrix and origin.
The view matrix.
(Optional) The origin.
A CM::Transform3D.
Get a Mastercam Planes style matrix and origin from a given CM::Transform3D object.
A transform.
The requested components.
Get a Mastercam style matrix and origin from a given CM::Transform3D object.
A transform.
The requested components.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
A holder assembly deserialization implementation.
A holder assembly deserialization implementation.
Executes the reset ids operation.
The map of IDs that have been changed.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
First Unwraps the holder assemblies then queries if 'other' is the same type.
Type possibilities are TlHolderAssembly, TlTurnHolder, and TlAdaptiveItem.
The other holder assembly.
True if same type, false if not.
First Unwraps the holder assemblies then queries if 'other' is the same type.
Type possibilities are TlHolderAssembly, TlTurnHolder, and TlAdaptiveItem.
The other holder assembly.
True if same type, false if not.
Unwraps the holder assembly into a TlTurnHolder or TlAdaptiveItem if there's
a single component.
If not nullptr, then a TlTurnHolder or TlAdaptiveItem as a TlObjectPtr.
Unwraps the holder assembly into a TlTurnHolder or TlAdaptiveItem if there's
a single component.
If not nullptr, then a TlTurnHolder or TlAdaptiveItem as a TlObjectPtr.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Updates the projection length adjustment described by value.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
(Optional) True to get value in metric.
The projection length adjustment.
Updates the item model data.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Updates the underlying assembly item with the given value.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the underlying assembly item.
Null if it fails, else the item pointer.
Updates the component described by value.
The value.
True if it succeeds, false if it fails.
Gets component pointer.
Null if it fails, else the component pointer.
Applies the given transform to the parent connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Query if there is a child component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Removes the workpiece side connection described by value.
The connection identifier.
True if it succeeds, false if it fails.
Updates the connection described by value.
The value.
Adds a workpiece side connection to this component.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the map of workpiece side connections for this component.
Null if it fails, else the workpiece side connections.
Gets the parent connection pointer.
Null if it fails, else the parent connection pointer.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Gets item identifier.
The item identifier.
Gets component identifier.
The component identifier.
Sets the assembly.
The value.
Gets the assembly.
The assembly.
Constructor to create a view of the 3D tool assembly for a specific assembly component.
The assembly.
Identifier for the assembly component.
Constructor to create a view of the 3D tool assembly in machine position.
The assembly.
Generates wireframe for the tool.
The tool.
A Result.
Generates the wireframe for the lathe definition view.
The lathe definition view.
A Result.
Generates the wireframe for the tool assembly.
The tool assembly.
A Result.
A result set.
Values that represent result codes.
Merges composite node profiles.
The current profile.
The current node.
The insertion.
A merged profile.
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.
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.
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 holder nodes.
The root.
List of nodes.
Retrieves all const 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.
Retrieves all holder i ds.
The root.
[out] List of identifiers.
Updates the closest to tool properties.
Updates the closest to tool properties.
Inserts a holder node.
The identifier.
[in] The root.
[in] The child.
true if it succeeds, false if it fails.
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.
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.
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.
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.
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.
Resets all guids.
true if it succeeds, false if it fails.
Updates the is catalog item described by value.
The root.
True to value.
Updates the is catalog item described by value.
The root.
True to value.
Builds the composite.
Builds the composite.
Retrieve a specific holder node pointer.
The identifier.
The root.
.
Retrieve a specific holder node pointer.
The identifier.
The root.
.
Gets the holder tree root node.
The holder tree root node.
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 value.
(Optional) True if the value is metric.
true if it succeeds, false if it fails.
The Assembly tool projection was changed, so modify the main holder's CScalar to account for that.
The insertion value.
(Optional) True if the value is metric.
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.
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 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 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.
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.
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.
Deletes the holder described by holderID. If the delete operation results in a single holder,
it will be returned in the DeleteResult.
Identifier for the holder.
The DeleteResult.
Deletes the holder described by holderID. If the delete operation results in a single holder,
it will be returned in the DeleteResult.
Identifier for the holder.
The DeleteResult.
Encapsulates the result of deleting a holder.
Encapsulates the result of deleting a holder.
Adds a holder. If adding a holder into an occupied position, the holder will be inserted in place.
Identifier for the parent.
The holder.
The transform.
The transform.
The transform.
The scalar.
true if it succeeds, false if it fails.
Adds a holder. If adding a holder into an occupied position, the holder will be inserted in place.
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.
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.
Query if this object is linear.
true if linear, false if not.
Copy constructor.
The TlHolderComposite to process.
Copy constructor.
The TlHolderComposite to process.
Parameterized constructor.
true if this object is metric.
Parameterized constructor.
true if this object is metric.
Executes the clone operation.
A TlObjectPtr.
Executes the clone operation.
A TlObjectPtr.
The children.
The children.
The transformation.
The transformation.
The transformation.
The transformation.
The transformation.
The transformation.
The holder.
The holder.
MFC Serialization function.
The archive.
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.
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 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.
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.
Sets a holder.
The holder.
Gets the holder.
The holder.
Gets the holder.
The holder.
Replaces this node's child with the passed in child.
The child.
Replaces this node's child with the passed in child.
The child.
Adds a child.
The child.
Adds a child.
The child.
Equality operator.
The right hand side.
true if the parameters are considered equivalent.
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.
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.
Assignment operator.
The const TlHolderTreeNode & to process.
A shallow copy of this object.
Adds a child.
The child.
Adds a child.
The child.
Clone Function.
A pointer to a copy of this object.
Clone Function.
A pointer to a copy of this object.
Parameterized constructor.
The holder.
The transformation.
The transformation.
The transformation.
The scalar.
Parameterized constructor.
The holder.
The transformation.
The transformation.
The transformation.
The scalar.
Move constructor.
The right hand side.
Move constructor.
The right hand side.
Parameterized constructor.
The node.
Parameterized constructor.
The node.
The matrix.
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.
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.
Array indexer operator.
Zero-based index of the.
The indexed value.
Parameterized constructor.
The matrix.
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.
Parameterized constructor.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
The const TransformationMatrixColumn & to process.
Default constructor.
Default constructor.
The data.
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.
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.
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.
Parameterized constructor.
The double to process.
The double to process.
The double to process.
The double to process.
Default constructor.
Default constructor.
Encapsulates the result of the construction of a profile.
Encapsulates the result of the construction of a profile.
Values that represent possible profile calculation result states.
Values that represent possible profile calculation result states.
The external (3rd Party) identifier of the tool assembly
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolLathe tool class type.
Query if the tool definition corresponding to the given slot number is being used by any toolpath
operations.
The tool definition slot.
True if the slot is tied to a milling tool definition, false for lathe.
The operation identifier to exclude when searching. For use when checking
from within the parameters of an existing operation.
True if the specified tool definition is used by operations, false if not.
Query if the tool definition corresponding to the given slot number is being used by any toolpath
operations.
The tool definition slot.
True if the slot is tied to a milling tool definition, false for lathe.
True if the specified tool definition is used by operations, false if not.
Creates a localized string representing the given milling tool type.
Type of the tool.
The tool type text.
Static class with the functionality made available by TlToolFunctions_CH.h. This class cannot be inherited.
Sets FacingXOvercutAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets FacingXOvercutAmount property in the specified units.
true to get value in metric.
TheFacingXOvercutAmount property.
Gets or sets the Facing X Overcut Amount
Sets FacingRetractionAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets FacingRetractionAmount property in the specified units.
true to get value in metric.
TheFacingRetractionAmount property.
Gets or sets the Facing Retraction Amount
Sets RoughOverlapAmount property in the specified units.
value to set.
true to specify value is in metric.
Gets RoughOverlapAmount property in the specified units.
true to get value in metric.
TheRoughOverlapAmount property.
Gets or sets the Rough Overlap Amount
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.
Gets or sets the 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.
Gets or sets the Rough Depth Of Cut
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCuttingConfigurationTurningBoring tool class type.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlOpType tool class type.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Group the parent belongs to.
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.
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.
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.
Gets the operation group identifier.
The operation group identifier.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
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.
Gets the operation type ids.
The operation type ids.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The ISelectToolFromManagerApplet managed adapter implementation.
Handle of the parent window.
The on tool selected callback.
Parameters needed to construct an instance of this applet type.
A select tool from manager applet.
Gets the single instance of the ISelectToolFromManagerApplet::Factory interface instance.
The reference to the ISelectToolFromManagerApplet::Factory interface instance.
Parameters needed to construct an instance of this applet type.
A select tool from manager applet.
Adds a series of imported items to the specified library.
Only tool libraries are supported at this time.
Full pathname of the library file.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the part list in the machine group determined by the context from
which the importer was launched from.
Only mill tools and mill tool assemblies are supported at this time.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the context from which the importer was launched from.
The imported items.
True if it succeeds, false if it fails.
Gets the source operation identifier if importing into a toolpath operation.
The identifier of the source toolpath operation if importing into a toolpath operation context, or
nullopt if not in the context of a toolpath.
Gets the logger.
A reference to an IToolDataImportLogger.
Constructor.
If non-null, the client context to direct to.
A tool data importer adapter.
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.
Constructor.
The client instance.
A tool data import logger adapter.
Saves the log to disk.
The full pathname of the file to save to.
True if it succeeds, false if it fails.
Logs a message to the logger.
The message.
The type of the message.
An enum constant representing the error option.
An enum constant representing the warning option.
An enum constant representing the message option.
Values that represent message types.
Interface for a logger for use during the tool import process.
Creates a new instance of the IToolDataImportLogger interface.
The new IToolDataImportLogger interface instance.
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.
A tool data import logger.
Values that represent the type of message.
Adds a series of imported items to the specified library.
Only tool libraries are supported at this time.
Full pathname of the library file.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the part list in the machine group determined by the context from
which the importer was launched from.
Only mill tools and mill tool assemblies are supported at this time.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the context from which the importer was launched from.
The imported items.
True if it succeeds, false if it fails.
Gets the source operation identifier if importing into a toolpath operation.
The identifier of the source toolpath operation if importing into a toolpath operation context, or null
if not in the context of a toolpath.
Gets the logger.
A reference to an IToolDataImportLogger.
A tool data import context.
Import the contents from the specified file into the specified context.
Full pathname of the file to import.
The context to import data through.
True if it succeeds, false if it fails.
Launches the user interface operation for this importer.
The context from which it has been launched.
Handle of the parent.
True if it succeeds, false if it fails.
Queries the importer on whether or not it will provide a interface for the user. If an interface is not
provided, and an interface is desired, a value of 'false' should be returned. Mastercam will supply
an interface in this case when one is supported.
True to put the responsibility for any user interaction within this importer. False to let Mastercam
handle the user interface responsibility.
Retrieves a set of possible file types that can be imported by this importer.
The import file types.
Retrieves the localized name of this tool data importer.
The name.
Constructor.
If non-null, the client importer to direct to.
Constructor.
If non-null, the client importer to direct to.
A tool data importer adapter.
Import the contents from the specified file into the specified context.
Full pathname of the file to import.
The context to import data through.
True if it succeeds, false if it fails.
Launches the user interface operation for this importer.
The context from which it has been launched.
Handle of the parent.
True if it succeeds, false if it fails.
Queries the importer on whether or not it will provide a interface for the user. If an interface is not
provided, and an interface is desired, a value of 'false' should be returned. Mastercam will supply
an interface in this case when one is supported.
True to put the responsibility for any user interaction within this importer. False to let Mastercam
handle the user interface responsibility.
Retrieves a set of possible file types that can be imported by this importer.
The import file types.
Retrieves the localized name of this tool data importer.
The name.
An interface for tool data import.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlInsertLatheDrill tool class type.
A deserialization implementation.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Executes the get default cutting side operation.
A TlCuttingSide.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
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.
The native instance.
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 the tool definition corresponding to the given slot number is being used by any toolpath
operations.
The tool definition slot.
True if the slot is tied to a milling tool definition, false for lathe.
(Optional) The operation identifier to exclude when searching. For use when
checking from within the parameters of an existing operation.
True if the specified tool definition is used by operations, false if not.
Creates a localized string representing the given milling tool type.
Type of the tool.
The tool type text.
Given two old lathe tools, compare them to find if they are equal.
The first lathe tool.
The second lathe tool.
true if the lathe tools are equal.
Given two old inserts, compare them to find if they are equal.
The first insert.
The second insert.
true if the inserts are equal.
Given two old holders, compare them to find if they are equal.
The first holder.
The second holder.
true if the holders are equal.
Gets tl manager.
The tl manager.
Gets the single instance of the IToolDataImporterManager interface.
The IToolDataImporterManager single instance.
Import the contents from the specified file into the specified context.
Full pathname of the file to import.
The context to import data through.
True if it succeeds, false if it fails.
Launches the user interface operation for this importer.
The context from which it has been launched.
Handle of the parent.
True if it succeeds, false if it fails.
Queries the importer on whether or not it will provide a interface for the user. If an interface is not
provided, and an interface is desired, a value of 'false' should be returned. Mastercam will supply
an interface in this case when one is supported.
True to put the responsibility for any user interaction within this importer. False to let Mastercam
handle the user interface responsibility.
Retrieves a set of possible file types that can be imported by this importer.
The import file types.
The IToolDataImporter interface.
Adds a series of imported items to the specified library.
Only tool libraries are supported at this time.
Full pathname of the library file.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the part list in the machine group determined by the context from
which the importer was launched from.
Only mill tools and mill tool assemblies are supported at this time.
The imported items.
True if it succeeds, false if it fails.
Adds a series of imported items to the context from which the importer was launched from.
The imported items.
True if it succeeds, false if it fails.
Gets the source operation identifier if importing into a toolpath operation.
The identifier of the source toolpath operation if importing into a toolpath operation context, or
nullopt if not in the context of a toolpath.
Gets the logger.
A reference to an IToolDataImportLogger.
A tool data import context.
Retrieves the localized name of this data importer.
The name.
A data importer.
Creates a new new instance of the ITlAssemblyItemFactory interface.
The new ITlAssemblyItemFactory instance.
Creates a lathe center.
True to create the item in metric units.
The new lathe center.
Creates an adaptive item.
True if metric.
The new adaptive item.
Creates a turn holder.
True if metric.
The new turn holder.
Creates threading insert.
The insert style.
Type of the thread.
True for the created insert to have metric values.
The new threading insert.
Creates a grooving insert using the passed in style and metric flag.
The style.
True for the created insert to have metric values.
The new grooving insert.
Creates a turning boring insert using the passed in shape code and metric flag.
The shape code.
True for the created insert to have metric values.
The new turn insert.
Creates a lathe tool using the values from the legacy tool.
The old tool.
The new lathe tool.
Creates a mill holder based on the input metric flag.
True for the created holder to have metric values.
The new mill holder.
Creates a mill tool using the values from the legacy tool.
The old tool.
The new mill tool.
Creates a mill tool using the passed in type and metric flag.
The type.
true for the created mill tool to have metric values.
The new mill tool.
Factory service class providing functionality for creating instances of the classes TlToolMill, TlHolder,
and TlToolLathe.
Creates a new new instance of the ITlAssemblyFactory interface.
The new ITlAssemblyFactory instance.
Creates a new TlAssemblyPtr from the parameters in the specified operation.
The operation.
A TlAssemblyPtr.
Creates a new TlAssemblyPtr from the old tool.
The old tool.
A TlAssemblyPtr.
Creates a new TlAssemblyPtr from the given tool.
The tool.
A TlAssemblyPtr.
Creates a new TlAssemblyPtr based on the tool type and metric flag.
Type of the tool.
true if this object is metric.
A TlAssemblyPtr.
Factory service class providing functionality for creating instances of class TlAssembly.
Gets a pointer to the global tool system.
The tool system.
Defines an alias representing zero-based index of the tool system.
Query if the main part tool list is empty.
true if empty, false if not.
Assigns the specified lathe tool to the provided operation.
The lathe tool to be assigned.
The operation to have tool information assigned to it.
Flag specifying how to initialize the operation tool offsets. 0 - from the tool,
1 - from the configuration.
true to initialize the operation tool station.
true to set the step/peck/coolant values from the tool.
Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece
material, 1 - From the tool, 2 - From defaults.
true if it succeeds, false if it fails.
Assigns the specified tool holder to the provided operation.
The tool holder to be assigned.
The operation to have tool holder information assigned to it.
true if it succeeds, false if it fails.
Assigns the specified tool to the provided operation.
The tool to be assigned.
The operation to have tool assembly information assigned to it.
Flag specifying how to initialize the operation tool offsets. 0 - from the
tool, 1 - from the configuration.
true to initialize the operation tool station.
true to set the step/peck/coolant values from the tool.
Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece
material, 1 - From the tool, 2 - From defaults.
true to always lock feedrates.
true if it succeeds, false if it fails.
Assigns the specified tool assembly to the provided operation.
The tool assembly to be assigned.
The operation to have tool assembly information assigned to it.
Flag specifying how to initialize the operation tool offsets. 0 - from the
tool, 1 - from the configuration.
true to initialize the operation tool station.
true to set the step/peck/coolant values from the tool.
Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece
material, 1 - From the tool, 2 - From defaults.
true to always lock feedrates.
true if it succeeds, false if it fails.
Launches the Classic Tool Manager Dialog.
True to launch the lathe tool manager. False to launch the mill tool manager.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Prompts the user to select a cutting parameter from the current tool component library.
The current tool library is the library set within the active machine definition. IsoGroup and
ToolDiameter parameters exist to provide initial filtering functionality.
Output parameter that will be filled in with the selected result.
ISO group that the current workpiece material belongs to.
The diameter of the current tool being used.
(Optional) If non-null, the parent.
True if a cutting parameter was selected. False otherwise.
Prompts the user to select a lathe tool assembly from the current tool component library.
The current tool library is the library set within the active machine definition.
Output parameter that will be filled in with the selected result.
(Optional) If non-null, the parent.
True if a lathe tool assembly was selected. False otherwise.
Prompts the user to select a tool assembly from the current tool component library.
The current tool library is the library set within the active machine definition.
Output parameter that will be filled in with the selected result.
(Optional) If non-null, the parent.
True if a tool assembly was selected. False otherwise.
Prompts the user to select a lathe tool assembly from the tools in the current Mastercam part file.
Output parameter that will be filled in with the selected result.
(Optional) If non-null, the parent.
True if a lathe tool assembly was selected. False otherwise.
Prompts the user to select a tool assembly from the tools in the current Mastercam part file.
Output parameter that will be filled in with the selected result.
(Optional) If non-null, the parent.
True if a tool assembly was selected. False otherwise.
Launches the Save to Level panel to save the mill geometry to levels.
The selected objects.
(Optional) If non-null, (Optional) the parent.
True if it succeeds, false if it fails.
Saves a geometry to level.
The selected objects.
(Optional) If non-null, (Optional) the parent.
True if it succeeds, false if it fails.
Saves a geometry to level.
The selected tools.
(Optional) If non-null, (Optional) the parent.
True if it succeeds, false if it fails.
Saves the tools to library.
The items to save.
Options for controlling the operation.
(Optional) If non-null, (Optional) the parent.
A SaveToLibResult.
Values that represent library tabs.
A save to library parameters.
Encapsulates the result of a save to library.
Launches the select insert definition panel to allow users to choose the active definition for their tool.
The multi-definition tool.
The result slot.
(Optional) If non-null, (Optional) the parent.
(Optional) The initially selected slot.
True if it succeeds, false if it fails.
Launches the select insert definition panel to allow users to choose the active definition for their tool.
The multi-definition tool.
The result slot.
(Optional) If non-null, (Optional) the parent.
(Optional) The initially selected slot.
True if it succeeds, false if it fails.
Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if
successful, will be placed in the input parameter "toolToEdit".
The 3D tool assembly to edit.
True to hide the parent window before launching the tool designer.
(Optional) If non-null, the parent.
(Optional) The initially selected slot.
true if it succeeds, false if it fails.
Launches the GAF Projection editing feature to edit the projections of the assembly provided at the input parameter "spResult".
If the assembly is successfully edited, and the input parameter "updatePart" is set to true, the assembly
will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" at that dialog, the newly created assembly will be in parameter "spResult".
The result.
true to update part.
(Optional) If non-null, the parent dialog to suspend.
true if the assembly has changed, false otherwise.
Launches the holder wizard to edit the holder of the assembly provided at the input parameter "spResult".
If the holder is successfully edited, and the input parameter "updatePart" is set to true, the holder
will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" at that dialog, the newly created assembly will be in parameter "spResult".
The result.
true to update part.
(Optional) If the holder is a composite holder, the index of the holder to edit.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the tool wizard to edit the tool of the assembly provided at the input parameter "spResult". If
the tool is successfully edited, and the input parameter "updatePart" is set to true, the tool will
be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spResult".
[in,out] The result.
true to update part.
(Optional) true to start on the last page (properties page) of the wizard.
(Optional) true to present the editor in read-only mode.
[in,out] (Optional) If non-null, the parent.
(Optional) From library.
true if it succeeds, false if it fails.
Launches the mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If
the assembly is successfully edited, and the input parameter "updatePart" is set to true, the
assembly will be updated in the Mastercam part tool list.
If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly
has changed" dialog will be presented to the user. In the event that the user selects "create new
assembly" from that dialog, the newly created assembly will be in parameter "spAssembly".
[in,out] The assembly.
True to update part.
(Optional) True if read only.
[in,out] (Optional) If non-null, the parent.
(Optional) From library.
true if it succeeds, false if it fails.
Launches the edit holder wizard to allow users to modify existing holders. The result of the edit holder
wizard, if successful, will be placed in the input parameter "spResult".
The result.
(Optional) true to present the editor in read-only mode.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the edit tool wizard to allow users to modify existing tools. The result of the edit tool wizard,
if successful, will be placed in the input parameter "spResult".
[in,out] The result.
(Optional) true to start on the last page (properites page) of the wizard.
(Optional) true to present the editor in read-only mode.
[in,out] (Optional) If non-null, the parent.
(Optional) From library.
true if it succeeds, false if it fails.
Launches the appropriate editor for the given lathe tool. The result of the tool editor, if successful, will be
placed in the input parameter 'spToolToEdit'.
The tool to edit.
The parameters for controlling the operation.
True if it succeeds, false if it fails.
Parameters for controlling behavior when editing a lathe tool.
Launches the tool designer panel to allow users to create a new 3D tool assembly. The function passed in should
handle a completed 3D tool and do with it whatever the client prefers. This workflow supports OK/New from the
tool designer, so a series of 3D tools can be created without exiting the tool designer.
The commit function to use when if/when the user selects OK/New in the tool designer.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
Launches the tool designer panel to allow users to create a new 3D tool assembly. The result of the tool designer,
if successful, will be placed in the input parameter "spResult".
The result.
True to hide the parent window before launching the tool designer.
If non-null, the parent.
true if it succeeds, false if it fails.
Launches the create new lathe center wizard to allow users to create their desired lathe centers. The
result of the create new lathe center wizard, if successful, will be placed in the input parameter
"spResult".
The result.
Identifier for the machine group.
If non-null, the parent window to minimize.
true if it succeeds, false if it fails.
Launches the create lathe tool dialog to allow users to create their desired tools. The result of the
create lathe tool dialog, if successful, will be placed in the input parameter "spResult".
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of the
create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'.
The result.
Identifier for the machine group, send in NULL_ID for a library tool.
If non-null, the parent.
True if it succeeds, false if it fails.
Launches the create new holder wizard to allow users to create their desired holders. The result of the
create new holder wizard, if successful, will be placed in the input parameter "spResult".
The result.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the create new tool wizard to allow users to create their desired tools. The result of the
create new tool wizard, if successful, will be placed in the input parameter "spResult".
The result.
(Optional) The initial tool type.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the create new mill assembly panel. The result of the create new mill assembly
panel, if successful, will be placed in the input parameter "spAssembly".
The assembly.
(Optional) If non-null, the parent.
True if it succeeds, false if it fails.
Deletes all lathe tools and mill assemblies from the main part tool list.
true if it succeeds, false if it fails.
Deletes a lathe tool from the main part tool list with slot identification information matching the input
parameter "slot".
The slot number of the tool to delete.
true if it succeeds, false if it fails.
Deletes a mill tool from the main part tool list with slot identification information matching the input
parameter "slot".
The slot number of the tool to delete.
(Optional) True if the user should be warned before deleting a tool used by
operations.
(Optional) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional) The parent window pointer to be given to the warning dialog (should it be
launched). This parameter should only be used if "true" was passed into the parameter
"warnIfUsed".
true if it succeeds, false if it fails.
Deletes an item from the main part tool list with identification information matching the input parameter
"id".
The identification number of the tool to delete.
(Optional) True if the user should be warned before deleting a tool used by
operations.
(Optional) True to delete the tool if the warning is suppressed and it is a used
tool.
(Optional) The parent window pointer to be given to the warning dialog (should it be
launched). This parameter should only be used if "true" was passed into the parameter
"warnIfUsed".
true if it succeeds, false if it fails.
Updates the lathe tool in the internal tool list that corresponds to the given lathe tool interface instance.
The lathe tool.
(Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing.
True if it succeeds, false if it fails.
Updates the tool assembly referenced by the slot information stored within the input tool.
The input tool.
(Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing.
true if it succeeds, false if it fails.
Updates an item in the main part tool list with the input parameter data. The input parameter's
identification information must match an existing item in the main part tool list.
The input.
(Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing.
true if it succeeds, false if it fails.
Updates an item in the main part tool list with the input parameter data. The input parameter's
identification information must match an existing item in the main part tool list. If the
assembly is successfully updated, and the input parameter "pAutomationParams" is specified, the
Assembly Changed Processor will be invoked to update all toolpath operations using the tool that
is updated, in accordance with the options specified in "pAutomationParams".
The tool assembly to update.
(Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing.
true if tool updated, false if failure.
Indicates an offset warning has occurred.
The created assembly (only populated if the user selected CreateNewAssembly via UI or AutomationMode = AssemblyChangedResult::CreateNewAssembly).
Cancel Changes.
Create a new assembly.
Update all assemblies.
Automation Mode to use, if Automate = true.
Automate Assembly/Tool Changed Processor UI prompts.
Note: The automation parameters include this automation flag so that the caller may capture a reference to a created assembly or
if an offset warning has occurred, even when automation is off and the user is prompted via the UI for how to handle
AssemblyChanged decisions.
IToolSystem::Update(...) automation parameters.
Queries if any lathe tools in the tool system satisfy the given predicate.
The predicate to evaluate against.
True if any lathe tools satisfy the given predicate.
Queries if any mill tool assemblies in the tool system satisfy the given predicate.
The predicate to evaluate against.
True if any mill tool assemblies satisfy the given predicate.
Searches for matching lathe tools in the tool manager. The predicate parameter will be executed on all 3d
tools and legacy lathe tools. Items that result in a value of 'true' when passed into the predicate
will be added to the result set.
A function predicate used to select all matching lathe tools from the Mastercam part tool
list.
The result set.
Searches for matching mill tools in the tool manager. The predicate parameter will be executed on all
mill tools. Items that result in a value of 'true' when passed into the predicate will be added to
the result set.
A function predicate used to select all matching mill tools from the Mastercam part tool
list.
The result set.
Searches for the first item for which predicate 'pred' returns true.
A function predicate used to select the appropriate tool from the Mastercam part tool list.
This function parameter will be executed on each tool in the list until a value of "true" is
returned.
true if it succeeds, false if it fails.
Searches for the first item for which predicate 'pred' returns true.
A function predicate used to select the appropriate tool from the Mastercam part tool list.
This function parameter will be executed on each tool in the list until a value of "true" is
returned.
The result or nullptr if not found.
Constructs a list of all lathe tools from the main part tool list. The result list is composed of smart pointers
to interfaces that wrap the items from the internal tool list.
A set of all lathe tools in the main part tool list.
Constructs a list of all items of type TlToolAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolAssembly.
Constructs a list of all items of type TlToolLathe from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlToolLathe.
Constructs a list of all items of type TlAssembly from the main part tool list. The result list is
composed of non-modifiable smart pointers that directly point to the items from the internal tool
list. If changes are desired to any individual item in the result set, the "Clone" method should be
called on the item to create a deep copy to work with.
A set of all items in the main part tool list of type TlAssembly.
Attempts to locate the lathe tool with a slot number matching the input parameter "slot". If an item is found,
the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find'
returns (by reference parameter) a shared pointer to a const version of the actual item in storage.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the input
parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by
reference parameter) a shared pointer to a const version of the actual item in storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate a 3D tool corresponding to the slot number specified at input parameter "slot". Because 3D
tools live in both the mill and lathe tool lists, input parameter "slotIsMill" is used to determine whether to
look for the tool from the lathe slot list or the mill slot list.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with a slot number matching the input parameter "slot". If an item is found,
the input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with a slot number matching the input parameter "slot". If an item is found,
the input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The slot.
The result.
true if it succeeds, false if it fails.
Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the
input parameter "spResult" will be updated with a deep copy of the located item. This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The identifier.
The result.
true if it succeeds, false if it fails.
Prepares the provided item using the settings in the specified machine group, and then adds the item to
the specified machine group. If not suppressed, this function will warn the user of any similar
items that already exist within the specified machine group. If the add is successful, the input
parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially
station number.
The sp input.
Identifier for the machine group. A value of 'NULL_ID' will add the tool
to the active machine group.
(Out) True if the user cancelled the operation.
(Optional) true to warning on similar tools.
(Optional) true to add if similar exists.
(Optional) true to initialize offsets.
(Optional) true to suppress tool number warning.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Prepares the provided item using the settings in the specified machine group, and then adds the item to
the specified machine group. If not suppressed, this function will warn the user of any similar
items that already exist within the specified machine group. If the add is successful, the input
parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially
station number.
The sp input.
Identifier for the machine group. A value of 'NULL_ID' will add the tool
to the active machine group.
(Out) True if the user cancelled the operation.
(Optional) true to warning on similar tools.
(Optional) true to add if similar exists.
(Optional) true to initialize offsets.
(Optional) true to suppress tool number warning.
(Optional) true to add copy to name if similar tool.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. All definitions defined for the given 3D tool
assembly will have a unique slot number assigned to them prior to adding to the tool list.
The item to add to the current part's main tool list.
True if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Adds the provided item to the current part's main tool list. An open slot number will be determined and
assigned to the item as it is added to the part tool list. If the add is successful, the input
parameter's slot number will be updated to reflect how it was stored. This slot number can be used
to access and/or update the item from the main tool list.
The item to add to the current part's main tool list.
true if it succeeds, false if it fails.
Interface into the main Mastercam tool system.
The center point of the plane.
The reference direction of the plane.
The normal vector of the plane.
Constructor.
The normal.
The reference direction.
The center point.
Information about a plane.
Gets or sets the Material cutting speed percentage.
Gets or sets the material feed per revolution percentage.
Gets or sets the units of the spindle speed property.
Gets or sets the spindle speed for this configuration.
Gets or sets the units of the plunge rate property.
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.
Gets or sets the plunge rate for this configuration.
Gets or sets the units of the feedrate property.
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.
Gets or sets the feed rate for this configuration.
Gets or sets the cutting material index.
Gets or sets the coolant for this configuration.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlCuttingConfiguration tool class type.
Sets Width property in the specified units.
value to set.
true to specify value is in metric.
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 Width property in the specified units.
true to get value in metric.
TheWidth property.
Gets or sets the width of the connection.
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.
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 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 the thickness of the connection.
Gets or sets a value indicating whether the connection is round or square.
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 locator for the connection defined relative to the parent origin.
Gets or sets the connection size string.
Gets or sets the connection size string.
Gets or sets the connection type string.
Gets or sets the connection type string.
Makes a deep copy of this object.
nullptr if it fails, else a 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.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Default Constructor.
Defines the TlConnection tool class type.
Defines the TlConnection tool class type.
Transforms the current profile by the given transformation.
The transformation.
Type of the transformation.
Transforms the current profile by the given transformation.
The transformation.
Type of the transformation.
Scales the current profile.
The scale factor.
Scales the current profile.
The scale factor.
Trim or extend to y coordinate value.
The value.
Trim or extend to y coordinate value.
The value.
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 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.
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 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.
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.
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.
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.
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.
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.
Linearizes this profile into strictly line segments.
Sorts the profile.
true if it succeeds, false if it fails.
Sorts the profile.
true if it succeeds, false if it fails.
Validates the profile quadrant.
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.
true if it succeeds, false if it fails.
Swap the segments at index1 and index2.
The first index.
The second index.
true if it succeeds, false if it fails.
Swap the segments at index1 and index2.
The first index.
The second index.
true to reverse direction of the resulting index1 segment.
true if it succeeds, false if it fails.
Swap the segments at index1 and index2.
The first index.
The second index.
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.
The number of profile segments with height.
Gets the number of profile segments with height.
The number of profile segments with height.
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.
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.
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.
The profile from the top down.
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.
The profile from the top down.
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 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.
Gets the segment at the specified index.
Zero-based index of the segments.
The segment.
Clears the profile.
Clears the profile.
Sets calculate tolerance.
The value.
Sets calculate tolerance.
The value.
Gets calculate tolerance.
The calculate tolerance.
Gets calculate tolerance.
The calculate tolerance.
Gets segment count.
The segment count.
Gets segment count.
The segment count.
True length of profile in Y, including section below X axis
said length
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
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
Checks to see if this profile is empty
true if empty, else false
Makes a deep copy of this object.
nullptr if it fails, else a 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.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Default Constructor.
Defines the TlProfile tool class type.
Defines the TlProfile tool class type.
Gets scaled segment.
The scale factor.
The scaled segment.
Gets scaled segment.
The scale factor.
The scaled segment.
Scales this segment.
The scale factor.
Scales this segment.
The scale factor.
Gets rotated segment.
The radians.
The about point.
The rotated segment.
Gets rotated segment.
The radians.
The about point.
The rotated segment.
Gets rotated segment.
The radians.
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 about the passed in point.
The radians.
The about point.
Rotates this object.
The radians.
Rotates this object.
The radians.
Gets mirrored segment.
true to about y coordinate axis.
The mirrored segment.
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.
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.
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.
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.
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.
Transforms the current segment by the given transformation.
The transformation.
Type of the transform.
Gets reversed segment.
The reversed segment.
Gets reversed segment.
The reversed segment.
Validates the quadrant.
true if it succeeds, false if it fails.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
Reverses the segment.
Reverses the segment.
Trim at x coordinate value.
The x coordinate.
A TlProfileSegmentPtr.
Trim at x coordinate value.
The x coordinate.
A TlProfileSegmentPtr.
Trim at x coordinate value.
The x coordinate.
(Optional, defaults to true) true to keep lower segment.
A TlProfileSegmentPtr.
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.
A TlProfileSegmentPtr.
Trim at y coordinate value.
The y value to trim to.
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.
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 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.
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.
Sets calculate tolerance.
The value.
Gets calculate tolerance.
The calculate tolerance.
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.
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 maximum width.
The maximum width.
Gets top width.
The top width.
Gets top width.
The top width.
Gets bottom width.
The bottom width.
Gets bottom width.
The bottom width.
Height of segment.
said height.
Height of segment.
said height.
Gets the length of this profile segment.
The length.
Gets the length of this profile segment.
The length.
Gets the end endpoint of this segment.
The end endpoint.
Gets the end endpoint of this segment.
The end endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Lowest point contained in segment.
Lowest point contained in segment.
Lowest point contained in segment.
Lowest point contained in segment.
Minimum x coordinate.
A double.
Minimum x coordinate.
A double.
Highest point contained in segment.
Highest point contained in segment.
Highest point contained in segment.
Highest point contained in segment.
Maximum x coordinate.
A double.
Maximum x coordinate.
A double.
Conversion function.
vector of TlProfileLineSegmentPtr representing this object, linearized.
Conversion function.
vector of TlProfileLineSegmentPtr representing this object, linearized.
An enum constant representing the scale option.
An enum constant representing the scale option.
An enum constant representing the translation option.
An enum constant representing the translation option.
An enum constant representing the rotation option.
An enum constant representing the rotation option.
An enum constant representing the mirror option.
An enum constant representing the mirror option.
Values that represent the various possible transformations for a segment.
Values that represent the various possible transformations for a segment.
Color
Color
Makes a deep copy of this object.
nullptr if it fails, else a 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.
Copies from described by item.
The item.
true if it succeeds, false if it fails.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Default Constructor.
Constructor.
The x coordinate.
The y coordinate.
Constructor.
The x coordinate.
The y coordinate.
The Y coordinate of the point.
The Y coordinate of the point.
The X coordinate of the point.
The X coordinate of the point.
Point2D.
Point2D.
Defines the TlProfileSegment tool class type.
Defines the TlProfileSegment tool class type.
Tests if ToolImage reference property is set.
true if ToolImage is set, false if not.
Gets or sets the tool image.
Tests if CuttingConfiguration reference property is set.
true if CuttingConfiguration is set, false if not.
Gets or sets the cutting configuration.
Sets ClearanceHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ClearanceHeight property in the specified units.
true to get value in metric.
TheClearanceHeight property.
Gets or set the clearance height.
Sets ClearanceWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ClearanceWidth property in the specified units.
true to get value in metric.
TheClearanceWidth property.
Gets or set the clearance width.
Gets or sets the clearance end angle.
Gets or sets the clearance side angle.
Sets CompRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets CompRadius property in the specified units.
true to get value in metric.
TheCompRadius property.
Gets or sets the compensation radius.
Gets or sets the compensation quadrant.
Gets or sets the compensation method.
Sets CompPointXlateY property in the specified units.
value to set.
true to specify value is in metric.
Gets CompPointXlateY property in the specified units.
true to get value in metric.
TheCompPointXlateY property.
Gets or sets the Y portion of the compensation point translation.
Sets CompPointXlateX property in the specified units.
value to set.
true to specify value is in metric.
Gets CompPointXlateX property in the specified units.
true to get value in metric.
TheCompPointXlateX property.
Gets or sets the X portion of the compensation point translation.
Gets or sets a value indicating whether the feed/plunge direction is reversed.
Sets HomePositionZ property in the specified units.
value to set.
true to specify value is in metric.
Gets HomePositionZ property in the specified units.
true to get value in metric.
TheHomePositionZ property.
Gets or sets the home position Z value.
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.
Gets or sets the home position X value.
Gets or sets the assembly insert identifier.
Gets or sets the back offset value.
Gets or sets the tool offset value.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlLatheDefinition tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyConfiguration tool class type.
Query if this turn holder is defined for Y-Axis cutting by inspecting its item.
True if defined for y coordinate axis cutting, false if not.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyTurnHolder tool class type.
Gets or sets a value indicating whether the insert's cutting plane is set up for Y-Axis cutting
The type of the holder
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlTurnHolder tool class type.
Query if this insert is defined for Y-Axis cutting by inspecting its parent component.
True if defined for y coordinate axis cutting, false if not.
Gets or sets a value indicating whether the insert is pointed front relative to the operator in its position on the assembly.
Gets or sets a value indicating whether the tool's IsInverted flag should be negated for this insert.
Gets or sets a value indicating whether the insert is pointed up in its position on the assembly.
Gets or sets the active spindle used with this assembly insert.
Gets or sets the cutting side.
Gets or sets the boundary generation parameters.
Gets or sets the cutting plane locator.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyInsert tool class type.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Updates the projection length adjustment described by value.
The value.
True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
True to get value in metric.
The projection length adjustment.
Updates the item model data.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Gets the identifiers of the assembly items contained within this component's child and all its children.
The item identifiers.
Gets the identifiers of the assembly items contained within this component and all its children.
The item identifiers.
Applies the given transform to the parent connection.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Gets a const pointer to the connection described by connectionId
Identifier for the connection.
Null if it fails, else the connection.
Gets the connection for the child component described by childId.
Identifier for the child.
Null if it fails, else the child connection.
Inserts the given component above the child component specified by the given identifier.
Identifier for the child.
The new component to insert above a specific child.
True if it succeeds, false if it fails.
Duplicates the child component described by childId. Searches down the tree from this component should the child
to duplicate not directly exist on this component.
Identifier for the child.
The ID of the new component if successful, or GUID_NULL if not.
Deletes the child and all children described by childId.
Identifier for the child.
True if it succeeds, false if it fails.
Deletes the child component described by childId. Searches down the tree from this component should the child to
delete not directly exist on this component.
Identifier for the child.
True if it succeeds, false if it fails.
Updates the child component described by child. Searches down the tree from this component should the child to
update not directly exist on this component.
The child.
True if it succeeds, false if it fails.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Gets the child component attached to the workpiece side connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the child attached to connection.
Query if there is a child component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Gets a const pointer to the child described by childId. Searches down the tree from this component should the
child not directly exist on this component.
Identifier for the child component.
Null if it fails, else the child.
Adds a child component to this component.
The child component.
True if the child component should get the existing parent workpiece
side connection's type and size.
True if it succeeds, false if it fails.
Adds a child component to this component.
Adds a child component to this component.
The child component.
True if it succeeds, false if it fails.
Gets the set of inserts beneath this component.
The children insert components.
Gets the identifiers of all children of this component
The child identifiers.
Gets the set of child components.
True to include, false to exclude the children of children.
The children components.
Gets the set of child components.
The children components.
Removes the workpiece side connection described by value.
The connection identifier.
True if it succeeds, false if it fails.
Adds a workpiece side connection to this component.
The value.
True if it succeeds, false if it fails.
Gets the next parent connection pointer.
Null if it fails, else the next parent connection pointer.
Gets the previous parent connection pointer.
Null if it fails, else the previous parent connection pointer.
Gets the parent connection pointer.
The parent connection pointer.
Gets machine side connection pointer.
The machine side connection pointer.
Gets the parent pointer.
The parent pointer.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets or sets the ID of the parent component's connection that defines how to locate this component.
Tests if Item reference property is set.
true if Item is set, false if not.
Gets or sets the item associated to this component.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyComponent tool class type.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlInsert tool class type.
Gets the front clearance point if there is one for this view.
True to get the clearance point in metric units.
The front clearance point.
Gets the back clearance point if there is one for this view.
True to get the clearance point in metric units.
The back clearance point.
Gets the tool center, which represents the location of the center of the tool's nose radius offset of the
origin based on compensation and clearance parameters.
True to get the tool center in metric units.
The tool center.
Gets tool axis angle offset from the primary insert's "tool facing up" position.
The tool axis angle offset from the primary insert in degrees.
Gets tool axis angle offset from machine connection plane's reference axis.
The tool axis angle offset from machine connection plane's reference axis in degrees.
Gets the offset along the tool axis between the machine connection and cutting plane centers.
The machine cut plane offset along tool axis.
Gets the offset along the tool axis between the machine connection and cutting plane centers.
The machine cut plane offset along tool axis.
Gets the offset in z-depth between the primary insert cutting plane and the active insert cutting plane
for this tool assembly.
The z-depth scalar offset between the cutting planes of the primary insert and current insert.
Gets the offset value from the machine tool axis to the cutting plane of the tool.
The machine tool axis cut plane offset.
Gets machine orientation.
The machine orientation.
Gets the cutting plane orientation.
The cutting plane orientation.
Gets the toolpath orientation.
The toolpath orientation.
Copies the tool image from primary definition.
True if it succeeds, false if it fails.
Gets whether the tool is a multi definition tool.
True if it succeeds, false if it fails.
Updates the type of the insert and associated definition cutting parameters.
The type.
True to copy existing cut parameters, false to use defaults.
True if it succeeds, false if it fails.
Updates the cutting plane transform described by xform.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Gets the cutting plane information for the insert represented by this view in the tool assembly's
coordinate system.
True to put the plane's center point in metric units.
The cutting plane.
Updates the insert connection transform described by xform.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the machine side connection transform described by xform.
The updated transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the compensation point translation described by value.
The value.
True if value is metric.
True if it succeeds, false if it fails.
Gets compensation point translation.
True to get value in metric.
The compensation point translation.
Sets the tool's understanding of spindle direction for this view as counterclockwise if 'value' is true,
or clockwise if false.
True to set relevant tool parameters for this view to operate on a counterclockwise spindle
direction, false for clockwise.
Gets a value indicating if the spindle direction is counterclockwise.
True if the evaluated spindle direction is counterclockwise for this view, false if clockwise.
Sets tool angle as if from the point of view of the current definition.
The value.
Gets the tool angle from the point of view of the current definition.
The tool angle.
Sets a value indicating whether the insert is front facing. Setting this on a Y-Axis tool will change the
compensation quadrant accordingly.
True to value.
Query if the insert is front facing. This is equivalent to insert up on conventional tools, but
represents compensation quadrant on Y-Axis tools.
True if insert front, false if not.
Sets a value indicating whether the insert is upward facing. Setting this to true on a Y-Axis tool will
change the active turret to be the lower turret.
The value to set.
Query if the insert is upward facing.
True if insert up, false if not.
Sets a value indicating whether the insert represented by this view is reversed in tool orientation from
the default based on setup related parameters.
The value to set.
Query if the orientation of this insert is reversed from the default based on setup related parameters.
True if reversed, false if not.
Sets a value indicating whether the insert is set up to be used on the left part spindle.
The value to set.
Query if the tool is set up to be used on the left part spindle.
True if left spindle, false if not.
Sets a value indicating whether the insert is set up to be loaded on an upper turret.
The value to set.
Query if the tool is set up to be loaded on an upper turret.
True if upper turret, false if not.
Sets a value indicating whether the tool assembly is vertical or horizontal. Only does anything if acting
on the primary insert on a tool not set as Y-Axis turning.
The value.
Query if the tool is set up vertical.
True if vertical, false if horizontal.
Sets compensation quadrant.
The value.
Gets compensation quadrant.
The compensation quadrant.
Query if this object has valid cut and no-cut boundaries.
True if valid cut and no-cut boundaries, false if not.
Sets the cutting profile.
The profile, which is expected to be at the definition view position.
True if the profile is in metric units. Defaults to assuming
system units.
The extents translation to optionally remove from the profile.
True to ignore tool angle.
Gets the non cutting profile in the specified units.
True to get the profile in metric. Defaults to retrieving the
profile in system units.
The extents translation to optionally apply to the result profile.
True to ignore tool angle.
The cutting profile.
Sets the cutting profile.
The profile, which is expected to be at the definition view position.
True if the profile is in metric units. Defaults to assuming
system units.
The extents translation to optionally remove from the profile.
True to ignore tool angle.
Gets the cutting profile in the specified units.
True to get the profile in metric. Defaults to retrieving the
profile in system units.
The extents translation to optionally apply to the result profile.
True to ignore tool angle.
The cutting profile.
Updates the boundary generation parameters described by value.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the boundary generation parameters.
Null if it fails, else the boundary generation parameters pointer.
Updates the cutting parameters described by value.
The value.
True if it succeeds, false if it fails.
Gets cutting parameters pointer.
Null if it fails, else the cutting parameters pointer.
Updates the definition described by value.
The value.
True if it succeeds, false if it fails.
Gets the primary insert definition.
Null if it fails, else the primary insert definition.
Gets definition pointer.
Null if it fails, else the definition pointer.
Updates the assembly holder described by value.
The value.
True if it succeeds, false if it fails.
Gets the parent assembly holder pointer.
Null if it fails, else the parent assembly holder pointer.
Updates the holder described by value.
The value.
True if it succeeds, false if it fails.
Gets holder pointer.
Null if it fails, else the holder pointer.
Updates the insert described by value.
The value.
True if it succeeds, false if it fails.
Gets insert pointer.
Null if it fails, else the insert pointer.
Updates the insert described by value.
The value.
True if it succeeds, false if it fails.
Gets insert pointer.
Null if it fails, else the insert pointer.
Updates the connection transform.
The connection.
The transform.
True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by value.
The value.
True if it succeeds, false if it fails.
Gets insert connection pointer.
Null if it fails, else the insert connection pointer.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Checks if the definition's tool offset or back-offset number is equal to any other definition's tool
offset or back-offset number on the assembly.
True if offset used.
True if back offset used.
Query if this object is a view of a definition on an insert on a Y-Axis turning holder.
True if y coordinate axis turning, false if not.
Query if this object is a view of a definition on the primary insert.
True if primary insert, false if not.
Query if this object is a view of the primary lathe definition for the definition's insert.
True if primary insert definition, false if not.
Query if this object is a view of the primary lathe definition.
True if primary definition, false if not.
Specialized version of setting the assembly where slot changes are assumed and the definition view is
maintained if possible.
The value.
Sets the assembly.
The value.
Gets the assembly.
The assembly.
Gets a value indicating whether the assembly is metric.
True if the assembly is defined in metric units, false if not.
Sets the active definition.
The existing slot.
Sets the slot number for this definition view.
The value.
Gets the slot.
The slot.
Gets the identifier.
The identifier.
Gets the type.
The type.
Makes a deep copy of this object.
A copy of this object.
Equality operator.
The right hand side.
True if the parameters are considered equivalent.
Constructor to create a view of the 3D tool assembly for a specific lathe definition defined on it.
The assembly.
The lathe definition slot.
Constructor to create a view of the 3D tool assembly in tool change position.
The assembly.
Constructor to create a view of the 3D tool assembly in tool change position.
An owning native pointer to a proxy wrapper around a shared pointer to a native instance.
Constructor.
The native instance.
Constructor.
The native instance.
A lathe definition view of a TlToolAssembly instance.
Move the specified component on the tree to the next or previous connection on its parent. If a component
already exists on that parent connection, the existing component is moved in a swap operation.
If a swap takes place and the action affects which insert is the primary insert, definitions will get
reordered to reflect the new tree order.
Identifier for the component.
True to move up, false to move down.
True if it succeeds, false if it fails.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Deletes the component described by the given identifier.
If the component is an insert, all definitions that reference it will be deleted. If the component is a
holder, all inserts and definitions beneath it will be deleted. If the component is an adaptive item,
deletion will only succeed if there is at most one child, and that child will take the place of the
deleted item in the component tree.
The identifier.
True if it succeeds, false if it fails.
Updates the insert described by value.
The value.
True if it succeeds, false if it fails.
Gets insert pointer for the given lathe definition identifier.
Identifier for the lathe definition.
Null if it fails, else the insert pointer for definition identifier.
Gets insert associated to the lathe definition at the specified slot.
The slot.
Null if it fails, else the insert for slot.
Gets insert associated to the primary lathe definition.
Null if it fails, else the insert.
Duplicates the insert described by the given ID and all definitions associated to the insert.
The identifier.
The ID of the new insert if successful, or GUID_NULL if not.
Duplicates the lathe definition to the specified insert.
Identifier for the definition to duplicate.
Identifier for the insert to duplicate to.
The ID of the new definition if successful, or GUID_NULL if not.
Duplicates the lathe definition described by the given ID.
The identifier of the definition to duplciate.
The ID of the new definition if successful, or GUID_NULL if not.
Deletes the lathe definition described by ID.
The identifier.
True if it succeeds, false if it fails.
Updates the lathe definition described by value.
The value.
True if it succeeds, false if it fails.
Gets the primary definition pointer for the specified assembly insert.
Identifier for the assembly insert.
Null if it fails, else the insert primary definition pointer.
Query if any definitions using the insert described by insertId.
Identifier for the insert.
True if any definitions are using the insert, false if not.
Gets the lathe definition with the specified identifier.
The identifier.
Null if it fails, else the lathe definition with the specified identifier.
Gets the lathe definition at the specified slot.
The slot.
Null if it fails, else the lathe definition at slot.
Query if 'slot' is the slot of a definition on the primary insert.
The slot.
True if lathe definition primary insert, false if not.
Query if 'slot' is the slot of the primary lathe definition on the insert it is associated to.
The slot.
True if primary insert definition, false if not.
Query if 'slot' is the slot of the primary lathe definition on this tool assembly.
The slot.
True if primary lathe definition, false if not.
Query if this tool assembly has a lathe definition at the specified slot.
The slot.
True if there's a contained lathe definition at the given slot, false if not.
Gets overall length.
The slot.
The overall length.
Query if any of the inserts on this tool assembly are defined for Y-Axis turning.
True if y coordinate axis turning insert, false if not.
Query if there are multiple inserts defined for this tool assembly.
True if there are multiple inserts defined for this tool, false if not.
Gets the primary lathe definition that represents the tool at tool change position.
Null if it fails, else the primary lathe definition.
Updates the holder described by updatedHolder.
The updated holder.
True if it succeeds, false if it fails.
Gets a pointer to the main holder of this 3D tool assembly.
Null if it fails, else the holder pointer.
Updates the component described by value.
The value.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Gets the next open lathe definition slot.
The open lathe definition slot.
Gets a collection of slots used by the contained lathe definitions.
The lathe definition slots.
The external (3rd Party) identifier of the tool assembly
The type of the tool
Gets or sets the graphics files associated to this tool assembly.
Gets or sets the accessory items for this tool assembly
Gets or sets the lathe definitions.
Gets or sets the assembly component tree.
Gets or sets the active turret that the tool is mounted on.
Gets or sets the angle of the tool in tool change position.
Gets or sets a value indicating whether the tool is inverted in tool change position.
Gets or sets a value indicating if the tool assembly is vertically oriented in tool change position.
Gets or sets a value indicating whether or not the tool assembly requires a tool locator.
Gets or sets the machine group that this tool assembly is part of.
Gets or sets the tool station value for this tool assembly.
Gets or sets the tool number for this tool assembly.
Gets or sets the metric flag for this tool assembly.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolAssembly tool class 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.
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 turn holder is defined for Y-Axis cutting by inspecting its item.
True if defined for y coordinate axis cutting, false if not.
Query if this turn holder is defined for Y-Axis cutting by inspecting its item.
True if defined for y coordinate axis cutting, false if not.
Gets a const pointer to the holder.
The pointer to the holder, nullptr if invalid.
Gets a const pointer to the holder.
The pointer to the holder, nullptr if invalid.
A stationary component configuration deserialization implementation.
A stationary component configuration deserialization implementation.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Default constructor.
Default constructor.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the set assembly pointer operation.
If non-null, the assembly.
Executes the set assembly pointer operation.
If non-null, the assembly.
Executes the reset ids operation.
The map of IDs that have been changed.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Query if this insert is defined for Y-Axis cutting by inspecting its parent component.
True if defined for y coordinate axis cutting, false if not.
Query if this insert is defined for Y-Axis cutting by inspecting its parent component.
True if defined for y coordinate axis cutting, false if not.
Gets the type of the insert.
The type.
Gets the type of the insert.
The type.
Sets the non cutting profile.
The value.
(Optional) True if the value is metric. Defaults to assuming system units.
Sets the non cutting profile.
The value.
(Optional) True if the value is metric. Defaults to assuming system units.
Gets the non cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the profile in
system units.
The cutting profile.
Gets the non cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the profile in
system units.
The cutting profile.
Sets the cutting profile.
The value.
(Optional) True if the value is metric. Defaults to assuming system units.
Sets the cutting profile.
The value.
(Optional) True if the value is metric. Defaults to assuming system units.
Gets the cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the profile in
system units.
The cutting profile.
Gets the cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the profile in
system units.
The cutting profile.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Gets a const pointer to the insert.
The pointer to the insert, or nullptr if not valid.
Gets a const pointer to the insert.
The pointer to the insert, or nullptr if not valid.
Gets the front clearance point if there is one for this view.
(Optional) True to get the clearance point in metric units.
The front clearance point.
Gets the back clearance point if there is one for this view.
(Optional) True to get the clearance point in metric units.
The back clearance point.
Gets the tool center, which represents the location of the center of the tool's nose radius offset of the
origin based on compensation and clearance parameters.
(Optional) True to get the tool center in metric units.
The tool center.
Gets tool axis angle offset from the primary insert's "tool facing up" position.
The tool axis angle offset from the primary insert in degrees.
Gets tool axis angle offset from machine connection plane's reference axis.
The tool axis angle offset from machine connection plane's reference axis in degrees.
Gets the offset along the tool axis between the machine connection and cutting plane centers.
The machine cut plane offset along tool axis.
Gets the offset along the tool axis between the machine connection and cutting plane centers.
The machine cut plane offset along tool axis.
Gets the offset in z-depth between the primary insert cutting plane and the active insert cutting plane
for this tool assembly.
The z-depth scalar offset between the cutting planes of the primary insert and current insert.
Gets the offset value from the machine tool axis to the cutting plane of the tool.
The machine tool axis cut plane offset.
Gets machine orientation.
The machine orientation.
Gets the cutting plane orientation.
The cutting plane orientation.
Gets the toolpath orientation.
The toolpath orientation.
Copies the tool image from primary definition.
True if it succeeds, false if it fails.
Gets whether the tool is a multi definition tool.
True if it succeeds, false if it fails.
Updates the type of the insert and associated definition cutting parameters.
The type.
(Optional) True to copy existing cut parameters, false to use defaults.
True if it succeeds, false if it fails.
Updates the cutting plane transform described by xform.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Gets the cutting plane information for the insert represented by this view in the tool assembly's
coordinate system.
(Optional) True to put the plane's center point in metric units.
The cutting plane.
Updates the insert connection transform described by xform.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the machine side connection transform described by xform.
The updated transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the compensation point translation described by value.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Gets compensation point translation.
(Optional) True to get value in metric.
The compensation point translation.
Sets the tool's understanding of spindle direction for this view as counterclockwise if 'value' is true,
or clockwise if false.
True to set relevant tool parameters for this view to operate on a counterclockwise spindle
direction, false for clockwise.
Gets a value indicating if the spindle direction is counterclockwise.
True if the evaluated spindle direction is counterclockwise for this view, false if clockwise.
Sets tool angle as if from the point of view of the current definition.
The value.
Gets the tool angle from the point of view of the current definition.
The tool angle.
Sets a value indicating whether the insert is front facing. Setting this on a Y-Axis tool will change the
compensation quadrant accordingly.
True to value.
Query if the insert is front facing. This is equivalent to insert up on conventional tools, but
represents compensation quadrant on Y-Axis tools.
True if insert front, false if not.
Sets a value indicating whether the insert is upward facing. Setting this to true on a Y-Axis tool will
change the active turret to be the lower turret.
The value to set.
Query if the insert is upward facing.
True if insert up, false if not.
Sets a value indicating whether the insert represented by this view is reversed in tool orientation from
the default based on setup related parameters.
The value to set.
Query if the orientation of this insert is reversed from the default based on setup related parameters.
True if reversed, false if not.
Sets a value indicating whether the insert is set up to be used on the left part spindle.
The value to set.
Query if the tool is set up to be used on the left part spindle.
True if left spindle, false if not.
Sets a value indicating whether the insert is set up to be loaded on an upper turret.
The value to set.
Query if the tool is set up to be loaded on an upper turret.
True if upper turret, false if not.
Sets a value indicating whether the tool assembly is vertical or horizontal. Only does anything if acting
on the primary insert on a tool not set as Y-Axis turning.
The value.
Query if the tool is set up vertical.
True if vertical, false if horizontal.
Sets compensation quadrant.
The value.
Gets compensation quadrant.
The compensation quadrant.
Query if this object has valid cut and no-cut boundaries.
True if valid cut and no-cut boundaries, false if not.
Gets the non-cutting boundary of the tool on the XY plane.
(Optional) True to get the boundary in metric units.
The non-cutting boundary.
Sets the cutting profile.
The profile, which is expected to be at the definition view position.
(Optional) True if the profile is in metric units. Defaults to assuming
system units.
(Optional) The extents translation to optionally remove from the profile.
(Optional) True to ignore tool angle.
Gets the non cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the
profile in system units.
(Optional) The extents translation to optionally apply to the result profile.
(Optional) True to ignore tool angle.
The cutting profile.
Gets the cutting boundary of the tool on the XY plane.
(Optional) True to get the boundary in metric units.
The cutting boundary.
Sets the cutting profile.
The profile, which is expected to be at the definition view position.
(Optional) True if the profile is in metric units. Defaults to assuming
system units.
(Optional) The extents translation to optionally remove from the profile.
(Optional) True to ignore tool angle.
Gets the cutting profile in the specified units.
(Optional) True to get the profile in metric. Defaults to retrieving the
profile in system units.
(Optional) The extents translation to optionally apply to the result profile.
(Optional) True to ignore tool angle.
The cutting profile.
Updates the boundary generation parameters using the specified action.
The update action.
True if it succeeds, false if it fails.
Updates the boundary generation parameters described by value.
The value.
True if it succeeds, false if it fails.
Gets a pointer to the boundary generation parameters.
Null if it fails, else the boundary generation parameters pointer.
Updates the cutting parameters using the specified action.
The update action.
True if it succeeds, false if it fails.
Updates the cutting parameters described by value.
The value.
True if it succeeds, false if it fails.
Gets cutting parameters pointer.
Null if it fails, else the cutting parameters pointer.
Updates the definition using the specified action.
The update action.
True if it succeeds, false if it fails.
Updates the definition described by value.
The value.
Gets the primary insert definition.
Null if it fails, else the primary insert definition.
Gets definition pointer.
Null if it fails, else the definition pointer.
Updates the assembly holder described by value.
The value.
True if it succeeds, false if it fails.
Gets the parent assembly holder pointer.
Null if it fails, else the parent assembly holder pointer.
Updates the holder described by value.
The value.
True if it succeeds, false if it fails.
Gets the parent holder item pointer.
Null if it fails, else the parent holder item pointer.
Updates the insert described by value.
The value.
Gets insert pointer.
Null if it fails, else the insert pointer.
Updates the insert described by value. Adds the insert if it doesn't already exist.
The value.
Gets insert pointer.
Null if it fails, else the insert pointer.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by value.
The value.
Gets insert connection pointer.
Null if it fails, else the insert connection pointer.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Checks if the definition's tool offset or back-offset number is equal to any other definition's tool offset or
back-offset number on the assembly.
True if offset used.
True if back offset used.
Query if this object is y coordinate axis turning.
True if y coordinate axis turning, false if not.
Query if this object is a view of a definition on the primary insert.
True if primary insert, false if not.
Query if this object is a view of the primary lathe definition for the definition's insert.
True if primary insert definition, false if not.
Query if this object is a view of the primary lathe definition.
True if primary definition, false if not.
Specialized version of setting the assembly where slot changes are assumed and the definition view is maintained
if possible.
The value.
Sets the assembly.
The value.
Gets the assembly.
The assembly.
Gets a value indicating whether the assembly is metric.
True if the assembly is defined in metric units, false if not.
Sets the active definition.
The existing slot.
Sets the slot number for this definition view.
The value.
Gets the slot.
The slot.
Gets the identifier.
The identifier.
Gets the type.
The type.
Makes a deep copy of this object.
A copy of this object.
Equality operator.
The right hand side.
True if the parameters are considered equivalent.
Constructor to create a view of the 3D tool assembly for a specific lathe definition defined on it.
The assembly.
The lathe definition slot.
Constructor to create a view of the 3D tool assembly in tool change position.
The assembly.
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.
Transform plane operator.
A Transform3D object.
A 3d plane position and orientation to transform.
Transformed 3d plane position and orientation.
Cast that converts the current plane information into a matrix representation Transform3D.
The result of the operation.
Assignment operator.
The plane matrix.
A reference to this object.
Information about a plane.
Check if the xy planes of two transforms are coplanar.
A transform.
Another transform.
Optional angle tolerance.
Optional zero tolerance.
true if same xy plane, false if not.
Check if the z-axis of two transforms are antiparallel.
A transform.
Another transform.
Optional angle tolerance.
true if antiparallel, false if not.
Check if the z-axis of two transforms are parallel.
A transform.
Another transform.
Optional angle tolerance.
true if parallel, false if not.
Check if the z-axis of two transforms are perpendicular.
A transform.
Another transform.
Optional angle tolerance.
true if perpendicular, false if not.
Convert the given transform 2D to 3D.
The transform 2D.
The transform 3D.
Builds a relative transform between two others.
Original transform.
Goal transform.
A Transform3D to apply to the original.
Builds a relative transform between two others.
Original transform.
Goal transform.
A Transform2D to apply to the original.
Builds a 3D mirror transform.
The normal of the reflecting plane.
The origin.
A Transform3D.
Builds a 2D mirror transform.
The line start.
The line end.
A Transform2D.
Builds rotation from axis angle.
The axis.
The angle.
A Transform3D.
Builds a 3D rotation around a point on given axis.
The point.
The rotation axis.
The angle.
A Transform3D.
Builds a 2D rotation around a point in the plane.
The point.
The angle.
A Transform2D.
Builds rotation from axis index and angle.
1 for Y, 2 for Z, all others will be X.
Zero-based index of the axis.
The angle.
A Transform3D.
Builds a 2D rotation from an angle.
The angle.
A Transform2D.
Builds transform from an axis and an origin.
This uses the "AutoCAD Arbitrary Axis Algorithm", which provides consistent orientations
(though arbitrary) for a given z axis.
The new z axis.
The origin.
A Transform3D.
Builds a transform from many points.
A plane is fit to the points, the origin is the average point position, and the normal is the average orientation assuming a CCW input order.
The points.
A Transform3D.
Builds a transform from three points.
The three points form a triangle in a plane. Point aP forms the base of the triangle and bP and cP
lead in the x and y directions, respectively. The z vector will be the plane normal.
The base point.
A point leading in the new x direction from the base.
A point leading in the new y direction from the base.
A Transform3D.
Builds a Transform3D object from a rotation and translation.
The 3x3 rotation matrix.
The 3d translation.
(Optional) A uniform scaling.
A Transform3D.
Builds a Transform2D object from a rotation and translation.
The 2x2 rotation matrix.
The 2d translation.
(Optional) A uniform scaling.
A Transform2D.
Builds a pure uniform scale object.
The amount of scaling.
A scale only Transform3D.
Builds a pure uniform scale object.
The amount of scaling.
A scale only Transform2D.
Builds a pure rotation object.
The 3x3 rotation amounts.
A rotation only Transform3D.
Builds a pure rotation object.
The 2x2 rotation amounts.
A rotation only Transform2D.
Builds a pure translation object.
The 2d translation amounts.
A translation only Transform2D.
Builds a pure translation object.
The 3d translation amounts.
A translation only Transform3D.
Matrix times transform operator.
A 4x4 matrix.
A 3D transform object.
A 4x4 matrix.
Transform matrix operator.
A 3D transform object.
A 4x4 matrix.
A 4x4 matrix.
Matrix times transform operator.
A 3x3 matrix.
A 2D transform object.
A 3x3 matrix.
Transform matrix operator.
A 2D transform object.
A 3x3 matrix.
A 3x3 matrix.
Transform assignment operator.
[in,out] The 6D float vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 6D double vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 3D float vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 3D double vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 2D float vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 2D double vector to transform.
A Transform3D object.
The transformed vector.
Transform assignment operator.
[in,out] The 2D float vector to transform.
A Transform2D object.
The transformed vector.
Transform assignment operator.
[in,out] The 2D double vector to transform.
A Transform2D object.
The transformed vector.
Transform vector operator.
A Transform3D object.
A 6d double vector to transform.
Transformed 6d vector.
Transform vector operator.
A Transform3D object.
A 6d double vector to transform.
Transformed 6d vector.
Transform vector operator.
A Transform3D object.
A 3d float vector to transform.
Transformed 3d vector.
Transform vector operator.
A Transform3D object.
A 3d double vector to transform.
Transformed 3d vector.
Transform vector operator.
A Transform2D object.
A 2d float vector to transform.
Transformed 2d float vector.
Transform vector operator.
A Transform2D object.
A 2d double vector to transform.
Transformed 2d double vector.
Right-handed permutations.
A simple index with a safety marker.
Possible orientations between two vectors.
A tool assembly deserialization implementation.
A tool assembly deserialization implementation.
Sets the various member TlToolAssembly pointers to this instance.
Sets the various member TlToolAssembly pointers to this instance.
Executes the reset ids operation.
The map of IDs that have been changed.
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.
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.
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.
Move the specified component on the tree to the next or previous connection on its parent. If a component
already exists on that parent connection, the existing component is moved in a swap operation.
If a swap takes place and the action affects which insert is the primary insert, definitions will get
reordered to reflect the new tree order.
Identifier for the component.
True to move up, false to move down.
True if it succeeds, false if it fails.
Move the specified component on the tree to the next or previous connection on its parent. If a component
already exists on that parent connection, the existing component is moved in a swap operation.
If a swap takes place and the action affects which insert is the primary insert, definitions will get
reordered to reflect the new tree order.
Identifier for the component.
True to move up, false to move down.
True if it succeeds, false if it fails.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Deletes the component described by the given identifier.
If the component is an insert, all definitions that reference it will be deleted. If the component is a
holder, all inserts and definitions beneath it will be deleted. If the component is an adaptive item,
deletion will only succeed if there is at most one child, and that child will take the place of the
deleted item in the component tree.
The identifier.
True if it succeeds, false if it fails.
Deletes the component described by the given identifier.
If the component is an insert, all definitions that reference it will be deleted. If the component is a
holder, all inserts and definitions beneath it will be deleted. If the component is an adaptive item,
deletion will only succeed if there is at most one child, and that child will take the place of the
deleted item in the component tree.
The identifier.
True if it succeeds, false if it fails.
Updates the insert described by value.
The value.
True if it succeeds, false if it fails.
Updates the insert described by value.
The value.
True if it succeeds, false if it fails.
Gets insert pointer for the given lathe definition identifier.
Identifier for the lathe definition.
Null if it fails, else the insert pointer for definition identifier.
Gets insert pointer for the given lathe definition identifier.
Identifier for the lathe definition.
Null if it fails, else the insert pointer for definition identifier.
Gets insert associated to the lathe definition at the specified slot.
The slot.
Null if it fails, else the insert for slot.
Gets insert associated to the lathe definition at the specified slot.
The slot.
Null if it fails, else the insert for slot.
Gets insert associated to the primary lathe definition.
Null if it fails, else the insert.
Gets insert associated to the primary lathe definition.
Null if it fails, else the insert.
Duplicates the insert described by the given ID and all definitions associated to the insert.
The identifier.
The ID of the new insert if successful, or GUID_NULL if not.
Duplicates the insert described by the given ID and all definitions associated to the insert.
The identifier.
The ID of the new insert if successful, or GUID_NULL if not.
Duplicates the lathe definition to the specified insert.
Identifier for the definition to duplicate.
Identifier for the insert to duplicate to.
The ID of the new definition if successful, or GUID_NULL if not.
Duplicates the lathe definition to the specified insert.
Identifier for the definition to duplicate.
Identifier for the insert to duplicate to.
The ID of the new definition if successful, or GUID_NULL if not.
Duplicates the lathe definition described by the given ID.
The identifier of the definition to duplciate.
The ID of the new definition if successful, or GUID_NULL if not.
Duplicates the lathe definition described by the given ID.
The identifier of the definition to duplciate.
The ID of the new definition if successful, or GUID_NULL if not.
Deletes the lathe definition described by ID.
The identifier.
True if it succeeds, false if it fails.
Deletes the lathe definition described by ID.
The identifier.
True if it succeeds, false if it fails.
Updates the lathe definition described by value.
The value.
True if it succeeds, false if it fails.
Updates the lathe definition described by value.
The value.
True if it succeeds, false if it fails.
Gets the primary definition pointer for the specified assembly insert.
Identifier for the assembly insert.
Null if it fails, else the insert primary definition pointer.
Gets the primary definition pointer for the specified assembly insert.
Identifier for the assembly insert.
Null if it fails, else the insert primary definition pointer.
Query if any definitions using the insert described by insertId.
Identifier for the insert.
True if any definitions are using the insert, false if not.
Query if any definitions using the insert described by insertId.
Identifier for the insert.
True if any definitions are using the insert, false if not.
Gets the lathe definition with the specified identifier.
The identifier.
Null if it fails, else the lathe definition with the specified identifier.
Gets the lathe definition with the specified identifier.
The identifier.
Null if it fails, else the lathe definition with the specified identifier.
Gets the lathe definition at the specified slot.
The slot.
Null if it fails, else the lathe definition at slot.
Gets the lathe definition at the specified slot.
The slot.
Null if it fails, else the lathe definition at slot.
Query if 'slot' is the slot of a definition on the primary insert.
The slot.
True if lathe definition primary insert, false if not.
Query if 'slot' is the slot of a definition on the primary insert.
The slot.
True if lathe definition primary insert, false if not.
Query if 'slot' is the slot of the primary lathe definition on the insert it is associated to.
The slot.
True if primary insert definition, false if not.
Query if 'slot' is the slot of the primary lathe definition on the insert it is associated to.
The slot.
True if primary insert definition, false if not.
Query if 'slot' is the slot of the primary lathe definition on this tool assembly.
The slot.
True if primary lathe definition, false if not.
Query if 'slot' is the slot of the primary lathe definition on this tool assembly.
The slot.
True if primary lathe definition, false if not.
Query if this tool assembly has a lathe definition at the specified slot.
The slot.
True if there's a contained lathe definition at the given slot, false if not.
Query if this tool assembly has a lathe definition at the specified slot.
The slot.
True if there's a contained lathe definition at the given slot, false if not.
Gets overall length.
The slot.
The overall length.
Gets overall length.
The slot.
The overall length.
Query if any of the inserts on this tool assembly are defined for Y-Axis turning.
True if y coordinate axis turning insert, false if not.
Query if any of the inserts on this tool assembly are defined for Y-Axis turning.
True if y coordinate axis turning insert, false if not.
Query if there are multiple inserts defined for this tool assembly.
True if there are multiple inserts defined for this tool, false if not.
Query if there are multiple inserts defined for this tool assembly.
True if there are multiple inserts defined for this tool, false if not.
Gets the primary lathe definition that represents the tool at tool change position.
Null if it fails, else the primary lathe definition.
Gets the primary lathe definition that represents the tool at tool change position.
Null if it fails, else the primary lathe definition.
Updates the holder described by updatedHolder.
The updated holder.
True if it succeeds, false if it fails.
Updates the holder described by updatedHolder.
The updated holder.
True if it succeeds, false if it fails.
Gets a pointer to the main holder of this 3D tool assembly.
Null if it fails, else the holder pointer.
Gets a pointer to the main holder of this 3D tool assembly.
Null if it fails, else the holder pointer.
Updates the component described by value.
The value.
True if it succeeds, false if it fails.
Updates the component described by value.
The value.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Gets machine side connection pointer.
Null if it fails, else the machine side connection pointer.
Gets the next open lathe definition slot.
The open lathe definition slot.
Gets the next open lathe definition slot.
The open lathe definition slot.
Gets a collection of slots used by the contained lathe definitions.
The lathe definition slots.
Gets a collection of slots used by the contained lathe definitions.
The lathe definition slots.
Move assignment operator.
The right hand side.
A shallow copy of this object.
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.
Assignment operator.
The right hand side.
A shallow copy of this object.
Move constructor.
The other tool assembly to move from.
Move constructor.
The other tool assembly to move from.
Copy constructor.
The other tool assembly.
Copy constructor.
The other tool assembly.
Default constructor.
Default constructor.
Executes the set assembly pointer operation.
If non-null, the assembly.
Executes the set assembly pointer operation.
If non-null, the assembly.
Resets all identifiers associated to this object.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Gets assembly insert pointer.
Null if it fails, else the assembly insert pointer.
Gets assembly insert pointer.
Null if it fails, else the assembly insert pointer.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the reset ids operation.
The map of IDs that have been changed.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Executes the set assembly pointer operation.
If non-null, the assembly.
Executes the set assembly pointer operation.
If non-null, the assembly.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Query if this object is metric.
True if metric, false if not.
Query if this object is metric.
True if metric, false if not.
Sets the tool assembly pointer.
If non-null, the assembly.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets the tool assembly pointer.
The tool assembly pointer.
Resets all identifiers associated to this object.
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.
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.
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.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Gets the root item pointer.
The root item pointer.
Gets the root item pointer.
The root item pointer.
Gets insert item identifiers.
The insert item identifiers.
Gets insert item identifiers.
The insert item identifiers.
Gets all identifiers of the assembly items contained within this component tree.
The item identifiers.
Gets all identifiers of the assembly items contained within this component tree.
The item identifiers.
Gets a collection of const pointers to the turn holders defined on this tree.
The turn holders.
Gets a collection of const pointers to the turn holders defined on this tree.
The turn holders.
Gets change in projection length adjustments.
The old tree.
Identifier for the component.
True if it changed, false if it did not change.
Gets change in projection length adjustments.
The old tree.
Identifier for the component.
True if it changed, false if it did not change.
Updates the projection length adjustment described by value.
Identifier for the component.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Updates the projection length adjustment described by value.
Identifier for the component.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
Identifier for the component.
(Optional) True to get value in metric.
The projection length adjustment.
Gets projection length adjustment.
Identifier for the component.
(Optional) True to get value in metric.
The projection length adjustment.
Updates the item model data.
Identifier for the component.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Updates the item model data.
Identifier for the component.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Applies the given transform to the parent connection.
Identifier for the component.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the parent connection.
Identifier for the component.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
Identifier for the component.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
Identifier for the component.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Removes the workpiece side connection.
Identifier for the component.
Identifier for the connection.
True if it succeeds, false if it fails.
Removes the workpiece side connection.
Identifier for the component.
Identifier for the connection.
True if it succeeds, false if it fails.
Adds a workpiece side connection to the component described by 'componentId'
Identifier for the component.
The connection.
True if it succeeds, false if it fails.
Adds a workpiece side connection to the component described by 'componentId'
Identifier for the component.
The connection.
True if it succeeds, false if it fails.
Gets the connections.
The connections.
Gets the connections.
The connections.
Gets the connections associated to the component described by 'componentId' that have changed when
compared with the state in the given component tree.
The old tree to compare against.
Identifier for the component.
The updated connections.
Gets the connections associated to the component described by 'componentId' that have changed when
compared with the state in the given component tree.
The old tree to compare against.
Identifier for the component.
The updated connections.
Gets component workpiece side connection map pointer.
Identifier for the component.
Null if it fails, else the component workpiece side connection map pointer.
Gets component workpiece side connection map pointer.
Identifier for the component.
Null if it fails, else the component workpiece side connection map pointer.
Gets component machine side connection pointer.
Identifier for the component.
Null if it fails, else the component machine side connection pointer.
Gets component machine side connection pointer.
Identifier for the component.
Null if it fails, else the component machine side connection pointer.
Gets a const pointer to the connection described by connectionId
Identifier for the connection.
Null if it fails, else the connection.
Gets a const pointer to the connection described by connectionId
Identifier for the connection.
Null if it fails, else the connection.
Gets the connection for the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert connection.
Gets the connection for the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert connection.
Gets a const pointer to the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert.
Gets a const pointer to the insert described by insertId.
Identifier for the insert.
Null if it fails, else the insert.
Gets a sorted list of the identifiers of all assembly insert components currently in this tree.
The sorted list of assembly insert identifiers.
Gets a sorted list of the identifiers of all assembly insert components currently in this tree.
The sorted list of assembly insert identifiers.
Gets a collection of const pointers to the inserts defined on this tree.
The inserts.
Gets a collection of const pointers to the inserts defined on this tree.
The inserts.
Attempts to add the given component onto the workpiece connection specified by the given identifier
provided that the specified connection exists and that there is not already a component on it.
Identifier for the workpiece-side connection.
The new component.
True if it succeeds, false if it fails.
Attempts to add the given component onto the workpiece connection specified by the given identifier
provided that the specified connection exists and that there is not already a component on it.
Identifier for the workpiece-side connection.
The new component.
True if it succeeds, false if it fails.
Attempts to insert the given component in the tree above the component specified by the given identifier.
Identifier for the component to add above.
The new component to add.
True if it succeeds, false if it fails.
Attempts to insert the given component in the tree above the component specified by the given identifier.
Identifier for the component to add above.
The new component to add.
True if it succeeds, false if it fails.
Duplicates the component in the tree with the specified identifier.
Identifier for the component.
The ID of the new component if successful, or GUID_NULL if not.
Duplicates the component in the tree with the specified identifier.
Identifier for the component.
The ID of the new component if successful, or GUID_NULL if not.
Deletes the component and all children described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Deletes the component and all children described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Deletes the component described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Deletes the component described by componentId.
Identifier for the component.
True if it succeeds, false if it fails.
Updates the item in the component in the tree described by componentId.
Identifier for the component.
The item.
True if it succeeds, false if it fails.
Updates the item in the component in the tree described by componentId.
Identifier for the component.
The item.
True if it succeeds, false if it fails.
Updates the component in the tree described by component.
The component.
True if it succeeds, false if it fails.
Updates the component in the tree described by component.
The component.
True if it succeeds, false if it fails.
Gets a pointer to the component that is attached to the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer attached to connection.
Gets a pointer to the component that is attached to the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer attached to connection.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Query if there is a component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Query if there is a component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Gets the identifier of the component containing the item with the specified identifier.
Identifier for the item.
The item component identifier.
Gets the identifier of the component containing the item with the specified identifier.
Identifier for the item.
The item component identifier.
Gets a pointer to the assembly component containing the item described by the given identifier.
Identifier for the item.
Null if it fails, else the item component pointer.
Gets a pointer to the assembly component containing the item described by the given identifier.
Identifier for the item.
Null if it fails, else the item component pointer.
Gets component item identifier.
Identifier for the component.
The component item identifier.
Gets component item identifier.
Identifier for the component.
The component item identifier.
Gets a pointer to the assembly item contained within the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component item pointer.
Gets a pointer to the assembly item contained within the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component item pointer.
Gets a pointer to the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component pointer.
Gets a pointer to the component described by the given identifier.
Identifier for the component.
Null if it fails, else the component pointer.
Gets the components in the tree.
The components.
Gets the components in the tree.
The components.
Gets a pointer to the machine side connection of the component tree.
The machine side connection pointer.
Gets a pointer to the machine side connection of the component tree.
The machine side connection pointer.
Sets the tool assembly pointer.
If non-null, the assembly.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets the tool assembly pointer.
The tool assembly pointer.
Executes the get item identifiers operation.
The identifiers.
Executes the get item identifiers operation.
The identifiers.
Executes the get child identifiers operation.
The identifiers.
Executes the get child identifiers operation.
The identifiers.
Executes the get children operation.
The results.
True to include, false to exclude the children of children.
Executes the get children operation.
The results.
True to include, false to exclude the children of children.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the set assembly pointer operation.
If non-null, the assembly.
Executes the set assembly pointer operation.
If non-null, the assembly.
Resets all identifiers associated to this object.
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.
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.
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.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Move the specified component to the next or previous connection on its parent.
Identifier for the component to move.
True to move up, false to move down.
True if it succeeds, false if it fails.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Determine if we can move the specified component.
Identifier for the component to investigate moving.
True to check moving up, false for moving down.
True if we can move component, false if not.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Updates the projection length adjustment described by value.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Updates the projection length adjustment described by value.
The value.
(Optional) True if value is metric.
True if it succeeds, false if it fails.
Gets projection length adjustment.
(Optional) True to get value in metric.
The projection length adjustment.
Gets projection length adjustment.
(Optional) True to get value in metric.
The projection length adjustment.
Updates the item model data.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Updates the item model data.
Information describing the model.
The name of the geometry file.
True if it succeeds, false if it fails.
Gets the identifiers of the assembly items contained within this component and all its children.
The item identifiers.
Gets the identifiers of the assembly items contained within this component and all its children.
The item identifiers.
Gets the identifiers of the assembly items contained within this component and all its children.
The item identifiers.
Gets the identifiers of the assembly items contained within this component and all its children.
The item identifiers.
Applies the given transform to the parent connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the parent connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Applies the given transform to the specified connection.
The connection.
The transform to apply.
(Optional) True if the transform is in metric units.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the machine side connection transform.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection transform.
The connection.
The transform.
(Optional) True if transform is metric.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Updates the connection described by connection.
The connection.
True if it succeeds, false if it fails.
Gets a const pointer to the connection described by connectionId
Identifier for the connection.
Null if it fails, else the connection.
Gets a const pointer to the connection described by connectionId
Identifier for the connection.
Null if it fails, else the connection.
Gets the connection for the child component described by childId.
Identifier for the child.
Null if it fails, else the child connection.
Gets the connection for the child component described by childId.
Identifier for the child.
Null if it fails, else the child connection.
Inserts the given component above the child component specified by the given identifier.
Identifier for the child.
The new component to insert above a specific child.
True if it succeeds, false if it fails.
Inserts the given component above the child component specified by the given identifier.
Identifier for the child.
The new component to insert above a specific child.
True if it succeeds, false if it fails.
Duplicates the child component described by childId. Searches down the tree from this component should the child
to duplicate not directly exist on this component.
Identifier for the child.
The ID of the new component if successful, or GUID_NULL if not.
Duplicates the child component described by childId. Searches down the tree from this component should the child
to duplicate not directly exist on this component.
Identifier for the child.
The ID of the new component if successful, or GUID_NULL if not.
Deletes the child and all children described by childId.
Identifier for the child.
True if it succeeds, false if it fails.
Deletes the child and all children described by childId.
Identifier for the child.
True if it succeeds, false if it fails.
Deletes the child component described by childId. Searches down the tree from this component should the child to
delete not directly exist on this component.
Identifier for the child.
True if it succeeds, false if it fails.
Deletes the child component described by childId. Searches down the tree from this component should the child to
delete not directly exist on this component.
Identifier for the child.
True if it succeeds, false if it fails.
Updates the child component described by child. Searches down the tree from this component should the child to
update not directly exist on this component.
The child.
True if it succeeds, false if it fails.
Updates the child component described by child. Searches down the tree from this component should the child to
update not directly exist on this component.
The child.
True if it succeeds, false if it fails.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Gets a pointer to the component that owns the connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the component pointer owning connection.
Gets the child component attached to the workpiece side connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the child attached to connection.
Gets the child component attached to the workpiece side connection specified by the given identifier.
Identifier for the connection.
Null if it fails, else the child attached to connection.
Query if there is a child component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Query if there is a child component attached to the workpiece side connection specified by the given
identifier.
Identifier for the connection.
True if child component at connection, false if not.
Gets a child pointer owning item.
Identifier for the child item.
The child pointer owning item.
Gets a child pointer owning item.
Identifier for the child item.
The child pointer owning item.
Gets a const pointer to the child described by childId. Searches down the tree from this component should the
child not directly exist on this component.
Identifier for the child component.
Null if it fails, else the child.
Gets a const pointer to the child described by childId. Searches down the tree from this component should the
child not directly exist on this component.
Identifier for the child component.
Null if it fails, else the child.
Adds a child component to this component.
The child component.
(Optional) True if the child component should get the existing parent
workpiece side connection's type and size.
True if it succeeds, false if it fails.
Adds a child component to this component.
The child component.
(Optional) True if the child component should get the existing parent
workpiece side connection's type and size.
True if it succeeds, false if it fails.
Gets the set of inserts beneath this component.
The children insert components.
Gets the set of inserts beneath this component.
The children insert components.
Gets the set of inserts beneath this component.
The children insert components.
Gets the set of inserts beneath this component.
The children insert components.
Gets the identifiers of all children of this component
The child identifiers.
Gets the identifiers of all children of this component
The child identifiers.
Gets the set of child components.
(Optional) True to include, false to exclude the children of children.
The children components.
Gets the set of child components.
(Optional) True to include, false to exclude the children of children.
The children components.
Removes the workpiece side connection described by value.
The connection identifier.
True if it succeeds, false if it fails.
Removes the workpiece side connection described by value.
The connection identifier.
True if it succeeds, false if it fails.
Adds a workpiece side connection to this component.
The value.
True if it succeeds, false if it fails.
Adds a workpiece side connection to this component.
The value.
True if it succeeds, false if it fails.
Gets the next parent connection pointer.
Null if it fails, else the next parent connection pointer.
Gets the next parent connection pointer.
Null if it fails, else the next parent connection pointer.
Gets the previous parent connection pointer.
Null if it fails, else the previous parent connection pointer.
Gets the previous parent connection pointer.
Null if it fails, else the previous parent connection pointer.
Gets the parent connection pointer.
The parent connection pointer.
Gets the parent connection pointer.
The parent connection pointer.
Gets workpiece side connection map pointer.
The workpiece side connection map pointer.
Gets workpiece side connection map pointer.
The workpiece side connection map pointer.
Gets machine side connection pointer.
The machine side connection pointer.
Gets machine side connection pointer.
The machine side connection pointer.
Gets the parent pointer.
The parent pointer.
Gets the parent pointer.
The parent pointer.
Sets the tool assembly pointer.
If non-null, the assembly.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets the tool assembly pointer.
The tool assembly pointer.
Gets the tool assembly pointer.
The tool assembly pointer.
Query if this object is metric.
True if metric, false if not.
Query if this object is metric.
True if metric, false if not.
Move assignment operator.
The right hand side.
A shallow copy of this object.
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.
Assignment operator.
The right hand side.
A shallow copy of this object.
Destructor.
Destructor.
Move constructor.
The other.
Move constructor.
The other.
Copy constructor.
The other.
Copy constructor.
The other.
Converts the given native instances into managed instances.
The native instances.
A list of converted instances.
Converts the given native instances into managed instances.
The native instances.
A list of converted instances.
Converts the given native instances into native instances.
The native instances.
The managed instances.
Converts the given native instances into native instances.
The native instances.
The managed instances.
Converts the given managed instances into native instances.
The managed instances.
The native instances.
Converts the given managed instances into native instances.
The managed instances.
A list of converted instances.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Converts a managed instance of the I3dLTool interface into a native instance.
If non-null, the managed instance.
The native instance of the I3dLTool interface.
Converts a managed instance of the ILTool interface into a native instance.
If non-null, the managed instance.
The native instance of the ILTool interface.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Converts a native instance of the ILTool interface into a managed instance.
The native instance.
Nullptr if it fails, else the given data converted to a managed instance.
Static helper methods for working with the tool interfaces.
Gets machine group display tools.
The machine group display tools.
Gets the machine group display tool.
Identifier for the group.
The machine group display tool.
Sets the specified tool as the machine group display tool.
Identifier for the group.
The lathe tool.
True if it succeeds, false if it fails.
Sets the specified tool as the machine group display tool.
Identifier for the group.
The assembly.
True if it succeeds, false if it fails.
Removes all the items and deletes all the memory used by those items.
Gets lathe tools.
The lathe tools.
Gets 3d tools.
The 3d tools.
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 correctly.
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 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 a lathe tool at the specified slot in the tool manager.
The slot.
The result tool.
true if the item is found, false otherwise.
Searches for a mill tool at the specified slot in the tool manager.
The slot.
The result 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.
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 the first match.
The identifier.
The tool.
True if it succeeds, false if it fails.
Searches for the first match.
The identifier.
The tool.
True if it succeeds, false if it fails.
Searches for the first match.
The identifier.
The tool.
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 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.
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.
The item to add to the list. A copy of the item will be created and added to the list, not
the parameter itself.
true if the item is added, false otherwise.
### Type of the type.
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.
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.
### Type of the type.
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.
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.
Constructor.
If non-null, the native instance to wrap.
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.
Creates a description of this tool using the given offset number.
The offset number.
The new description.
Lathe tooling cutting parameters for defining what the parameters in a toolpath will default to if requested.
An interface into lathe tooling compensation parameters, or null if not valid for the tool type.
Gets a value indicating if this tool definition is defined for Y-Axis turning.
Gets the holder orientation.
Gets the compensation quadrant.
Gets the toolpath orientation.
Gets ToolCenter property in the specified units.
true to get value in metric.
ToolCenter property.
Gets the tool center in tool units.
Gets or sets a value indicating whether the feed direction is reversed.
Sets ClearanceHeight property in the specified units.
value to set.
true to specify value is in metric.
Gets ClearanceHeight property in the specified units.
true to get value in metric.
ClearanceWidth property.
Gets or sets the clearance height in tool units
Sets ClearanceWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets ClearanceWidth property in the specified units.
true to get value in metric.
ClearanceWidth property.
Gets or sets the clearance width in tool units
Gets or sets the end clearance angle for this compensation configuration.
Gets or sets the side clearance angle for this compensation configuration.
Gets or sets the compensation method.
Gets or sets a value indicating whether the spindle direction for this tool is counter clockwise.
Gets or sets the tool angle
Gets or sets a value indicating whether this tool is reversed.
Gets or sets a value indicating whether this tool is vertical.
Sets HolderWidth property in the specified units.
value to set.
true to specify value is in metric.
Gets HolderWidth property in the specified units.
true to get value in metric.
HolderWidth property.
Gets or sets the holder width
Sets HolderThickness property in the specified units.
value to set.
true to specify value is in metric.
Gets HolderThickness property in the specified units.
true to get value in metric.
HolderThickness property.
Gets or sets the holder thickness
Gets or sets a value indicating whether the holder on this tool is round.
Gets or sets a value indicating whether the holder requires a tool locator for loading.
Gets or sets the insert name.
Sets InsertCornerRadius property in the specified units.
value to set.
true to specify value is in metric.
Gets InsertCornerRadius property in the specified units.
true to get value in metric.
InsertCornerRadius property.
Gets or sets the insert corner radius
Gets or sets the insert name.
Gets the type of the tool.
True to use custom type, meaning that if custom, the specialization will be
returned (Drill, Groove, etc.).
True to flag custom, meaning that if custom, the custom specialization types will
be used (CustomDrilling, CustomTurning, etc.).
The type.
Gets the type.
The type.
Sets HomePosition property in the specified units.
value to set.
true to specify value is in metric.
Gets HomePosition property in the specified units.
true to get value in metric.
TheHomePosition property.
Home Position Coordinate
Gets a value indicating whether this object is right handed.
Gets or sets the tool back offset number.
Gets or sets the tool offset number.
Gets the overall length of the tool in current system units.
An enum constant representing the horizontal quadrant 4 option.
An enum constant representing the horizontal quadrant 3 option.
An enum constant representing the horizontal quadrant 2 option.
An enum constant representing the horizontal quadrant 1 option.
An enum constant representing the vertical quadrant 4 option.
An enum constant representing the vertical quadrant 3 option.
An enum constant representing the vertical quadrant 2 option.
An enum constant representing the vertical quadrant 1 option.
Values that represent orientations.
An enum constant representing the quadrant 4 option.
An enum constant representing the quadrant 3 option.
An enum constant representing the quadrant 2 option.
An enum constant representing the quadrant 1 option.
Values that represent compensation quadrants.
Comp to tip of insert radius on C/L.
Comp using tangencies of two tool circles.
Comp to theoretical sharp corner of insert.
Comp to center of insert radius.
Values that represent compensation methods.
An enum constant representing the custom drilling option.
An enum constant representing the custom boring option.
An enum constant representing the custom grooving option.
An enum constant representing the custom threading option.
An enum constant representing the custom turning option.
An enum constant representing the live center option.
An enum constant representing the custom option.
An enum constant representing the drilling option.
An enum constant representing the boring option.
An enum constant representing the grooving option.
An enum constant representing the threading option.
An enum constant representing the turning option.
Values that represent lathe tool types.
A lathe tool interface.
Gets or sets the cutting speed percentage.
Gets or sets the feed per revolution percentage.
Gets or sets the units of the spindle speed.
Gets or sets the spindle speed.
Gets or sets the units of the plunge rates.
Sets the PlungeRate property in the specified units.
value to set.
true to specify value is in metric.
Gets the PlungeRate property in the specified units.
true to get value in metric.
The PlungeRate property.
Gets or sets the plunge rate.
Gets or sets the units of the feed rates.
Sets the FeedRate property in the specified units.
value to set.
true to specify value is in metric.
Gets the FeedRate property in the specified units.
true to get value in metric.
The FeedRate property.
Gets or sets the feed rate.
Gets or sets the tool material.
Gets or sets the canned text coolant.
Gets or sets the tool coolant.
An enum constant representing the constant surface speed option.
An enum constant representing the revolutions per minute option.
Values that represent spindle speed units.
An enum constant representing the feed per minute option.
An enum constant representing the feed per revolution option.
Values that represent feed rate units.
An enum constant representing the unknown option.
An enum constant representing the diamond option.
An enum constant representing the cubic boron nitride option.
An enum constant representing the ceramic option.
An enum constant representing the cermet option.
An enum constant representing the carbide option.
Values that represent materials.
An interface representing lathe tool cutting parameters.
Resets the identifiers.
Creates a description of this tool.
The new description.
Gets or sets the active turret.
Gets or sets the active spindle.
Gets or sets the manufacturer tool code.
Gets or sets the tool station.
Gets or sets the machine group identifier.
Gets or sets the tool number.
Gets or sets the name.
Gets a value indicating whether this object is metric.
Gets or sets the slot.
Gets the identifier.
An enum constant representing the maximum turrets option (for flag purposes only as a max value).
An enum constant representing the lower fixed turret option.
An enum constant representing the upper fixed turret option.
An enum constant representing the upper right turret option.
An enum constant representing the lower right turret option.
An enum constant representing the upper left turret option.
An enum constant representing the lower left turret option.
An enum constant representing the no active turret option.
Values that represent which turret is the active turret.
An enum constant representing the Maximum heads option (for flag purposes only as a max value).
An enum constant representing the Right spindle option.
An enum constant representing the Left spindle option.
Values that represent which spindle is the active spindle.
Interface for tools.
Saves the given tooling geometry to a file as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
Marshal parameters.
If non-null, options for controlling the operation.
The SaveAsGeometry::IAppletEngine::SaveToLevelParams.
Saves the given tooling geometry to levels as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
Saves the given tooling geometry to levels as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
Marshal parameters.
If non-null, options for controlling the operation.
The SaveAsGeometry::IAppletEngine::SaveToLevelParams.
Deletes the given set of geometry entities from the database.
The entities.
Retrieve the set of database pointers to pre-existing geometry on the specified level number.
The level number.
The set of database pointers to geometry entities on the specified level number.
Constructor.
The native instance.
Constructor.
The native instance.
An engine for the Save as Geometry Applet.
Saves the given tooling geometry to a file as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
Full pathname of the file to save to.
Type of the geometry.
A save to file parameters.
Saves the given tooling geometry to levels as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
Saves the given tooling geometry to levels as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
True to make the starting level the main level.
True to delete existing geometry.
The level increment.
The level number.
Type of the geometry.
A save to level parameters.
An enum constant representing the both option.
An enum constant representing the boundaries option.
An enum constant representing the solids option.
Values that represent geometry types to save.
Deletes the given set of geometry entities from the database.
The entities.
Retrieve the set of database pointers to pre-existing geometry on the specified level number.
The level number.
The set of database pointers to geometry entities on the specified level number.
An engine for the Save as Geometry Applet.
Creates a new instance of the IAppletEngine interface.
The new IAppletEngine interface instance.
Saves the given tooling geometry to a file as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
A save to file parameters.
Saves the given tooling geometry to levels as specified by the given parameters.
Information describing the tooling data to save.
Options for controlling the operation.
True if it succeeds, false if it fails.
A save to level parameters.
Values that represent geometry types to save.
Deletes the given set of geometry entities from the database.
The entities.
Retrieve the set of database pointers to pre-existing geometry on the specified level number.
The level number.
The set of database pointers to geometry entities on the specified level number.
An engine for the Save as Geometry Applet.
Gets the applet engine.
Runs this applet.
The result of the applet's run.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Creates a new instance of this applet type.
If non-null, options for controlling the operation.
Nullptr if it fails, else an IApplet^.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Marshal parameters.
If non-null, options for controlling the operation.
The native parameters.
Constructor.
The native instance.
The SaveAsGeometry::IApplet managed adapter implementation.
Gets the applet engine.
Full pathname of the initial file or null to use the current file.
The tooling data to save as geometry.
Parameters for running the Save as Geometry applet for the purpose of writing geometry to a file.
The tooling data to save as geometry.
Parameters for running the Save as Geometry applet for the purpose of writing lathe geometry to levels.
The tooling data to save as geometry.
Parameters for running the Save as Geometry applet for the purpose of writing milling geometry to levels.
The starting level or null to use the current level.
Parameters for running the Save as Geometry applet for the purpose of writing geometry to levels.
Options for controlling how the panel is run. Defaults to a stand-alone function panel.
The interface representing the SaveAsGeometry applet.
The interface representing the SaveAsGeometry applet.
Runs this applet.
The result of the applet's run.
A tooling applet.
Values that represent tooling applet results.
An enum constant representing the force cancel option.
An enum constant representing the cancel option.
An enum constant representing the ok option.
True if the designer should be launched in a read-only context.
An edit tool item parameters.
True if the designer should be configured to allow OK-New interactions, false if not.
True to create in metric units.
A create tool item parameters.
Options for controlling how the designer is run. Defaults to a stand-alone function panel.
Parameters for running tool item designers.
(Optional) The parent window to suppress.
Parameters required to run a function panel.
Gets the single instance of the ISaveToFileAppletFactory interface instance.
The reference to the ISaveToFileAppletFactory interface instance.
Gets the single instance of the ISaveToLevelAppletFactory interface instance.
The reference to the ISaveToLevelAppletFactory interface instance.
Gets the applet engine.
A reference to a const IAppletEngine.
Parameters for running the Save as Geometry applet for the purpose of writing geometry to a file.
Parameters for running the Save as Geometry applet for the purpose of writing geometry to levels.
Common parameters for running the applet.
The interface representing the SaveAsGeometry applet.
Runs this applet.
The result of the applet's run.
A tooling applet.
Values that represent tooling applet results.
An edit tool item parameters.
A create tool item parameters.
Parameters for running tool item designers.
Parameters required to run a modal panel (slide-over).
Parameters required to run a function panel.
A base tooling interface for the implicit standardization of special member functions.
Protected constructor to avoid deleting the implicit constructor in derived types, virtual destructor to
be implicitly carried forth by derived types, and deleted copy and move constructor or assignment
operators to prevent unintentional object slicing.
A deserialization implementation.
A deserialization implementation.
Executes the delete operation with knowledge on whether the delete is a pure delete or for an update.
The identifier.
True if the operation is for an update.
True if it succeeds, false if it fails.
Executes the delete operation with knowledge on whether the delete is a pure delete or for an update.
The identifier.
True if the operation is for an update.
True if it succeeds, false if it fails.
Searches for the first lathe tool with a matching identifier.
The identifier.
If true, does not check for matching items in an assembly.
The found lathe tool.
Searches for the first lathe tool with a matching identifier.
The identifier.
If true, does not check for matching items in an assembly.
The found lathe tool.
Searches for the first mill tool with a matching identifier.
The identifier.
If true, does not check for matching items in an assembly.
The found mill tool.
Searches for the first mill tool with a matching identifier.
The identifier.
If true, does not check for matching items in an assembly.
The found mill tool.
Gets lathe tools.
The lathe tools.
Gets lathe tools.
The lathe tools.
Gets mill tools.
The mill tools.
Gets mill tools.
The mill tools.
Gets lathe tool identifiers.
The lathe tool identifiers.
Gets lathe tool identifiers.
The lathe tool identifiers.
Gets mill tool identifiers.
The mill tool identifiers.
Gets mill tool identifiers.
The mill tool identifiers.
Query if the tool class instance corresponding to the given identifier is an ILTool type.
The identifier.
True if ILTool, false if not.
Query if the tool class instance corresponding to the given identifier is an ILTool type.
The identifier.
True if ILTool, false if not.
Query if the tool class instance corresponding to the given identifier is an IMTool type.
The identifier.
True if IMTool, false if not.
Query if the tool class instance corresponding to the given identifier is an IMTool type.
The identifier.
True if IMTool, false if not.
Gets the identifier of the given tool instance.
The tool.
The i tool identifier.
Gets the identifier of the given tool instance.
The tool.
The i tool identifier.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Creates an instance of the ITool interface.
The assembly.
The new tool interface instance.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Gets machine group display tools.
The machine group display tools.
Gets machine group display tools.
The machine group display tools.
Gets the machine group display tool.
Identifier for the group.
The machine group display tool.
Gets the machine group display tool.
Identifier for the group.
The machine group display tool.
Sets the specified tool as the machine group display tool. If already set as displayed, toggle it off.
Identifier for the group.
The lathe tool.
True if it succeeds, false if it fails.
Sets the specified tool as the machine group display tool. If already set as displayed, toggle it off.
Identifier for the group.
The lathe tool.
True if it succeeds, false if it fails.
Sets the specified tool as the machine group display tool. If already set as displayed, toggle it off.
Identifier for the group.
The assembly.
True if it succeeds, false if it fails.
Sets the specified tool as the machine group display tool. If already set as displayed, toggle it off.
Identifier for the group.
The assembly.
True if it succeeds, false if it fails.
Removes all the items and deletes all the memory used by those items.
Removes all the items and deletes all the memory used by those items.
Gets lathe tools.
The lathe tools.
Gets lathe tools.
The lathe tools.
Gets the assemblies.
The assemblies.
Gets the assemblies.
The assemblies.
Gets all tool class objects in this manager.
All objects.
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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.
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.
Retrieves the corrupted assembly list.
List of corrupted TlIds.
Opens slots on the given object based on the type of object and current state of this manager.
The object to open slots on.
Opens slots on the given object based on the type of object and current state of this manager.
The object to open slots on.
Find the lathe tool slot corresponding to the ID in question.
The identifier.
Slot of the specified lathe tool.
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 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 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.
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.
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.
Maps slots for use by wrapper lists when trying to open a slot.
map of slots.
Retrieves the slot map.
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 correctly.
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 correctly.
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 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 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 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 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 a lathe tool at the specified slot in the tool manager.
The slot.
The result tool.
true if the item is found, false otherwise.
Searches for a lathe tool at the specified slot in the tool manager.
The slot.
The result tool.
true if the item is found, false otherwise.
Searches for a mill tool at the specified slot in the tool manager.
The slot.
The result tool.
true if the item is found, false otherwise.
Searches for a mill tool at the specified slot in the tool manager.
The slot.
The result 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.
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.
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 slot.
[out] The assembly.
true if the item is found, false otherwise.
Updates a tool in the tool manager. The ID of the item is used to determine what item to update.
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 a tool in the tool manager. The ID of the item is used to determine what item to update.
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.
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.
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.
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.
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 function will create a new object copied
from the item parameter and store that copy.
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 function will create a new object copied
from the item parameter and store that copy.
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 a tool to the tool manager. This function will create a new object copied from the item parameter and
store that copy.
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 a tool to the tool manager. This function will create a new object copied from the item parameter and
store that copy.
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. This function will create a new object copied from the item parameter and
store that copy.
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. This function will create a new object copied from the item parameter and
store that copy.
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 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.
Deletes the given ID.
The id of the tool to look for.
true if it succeeds, false if it fails.
Accepts the given visitor.
The visitor.
Accepts the given visitor.
The visitor.
Accepts the given visitor.
The visitor.
Accepts the given visitor.
The visitor.
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.
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.
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.
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.
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.
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.
Assignment operator.
The right hand side.
A shallow copy of this object.
Copies the given TlMgr.
The other tlMgr.
true if it succeeds, false if it fails.
Copies the given TlMgr.
The other tlMgr.
true if it succeeds, false if it fails.
Move constructor.
The other.
Move constructor.
The other.
Copy Constructor. Creates a copy tool manager.
The other tlMgr.
Copy Constructor. Creates a copy tool manager.
The other tlMgr.
A default slot validator.
A default slot validator.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
Executes the set main holder action.
Executes the set main holder action.
Executes the set main insert action.
Executes the set main insert action.
Executes the get profile operation.
A TlProfileResult.
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.
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.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
The holder points array.
The holder points array.
The insert 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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Updates the main holder using the specified updater action.
The updater.
Updates the main holder using the specified updater action.
The updater.
Updates the main insert using the specified updater action.
The updater.
Updates the main insert using the specified updater action.
The updater.
Default constructor. Creates an empty tool.
Default constructor. Creates an empty tool.
A deserialization implementation.
A deserialization implementation.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
A deserialization implementation.
Executes the get default cutting side operation.
A TlCuttingSide.
Executes the get default cutting side operation.
A TlCuttingSide.
Executes the is cutting item operation.
True if it succeeds, false if it fails.
Executes the is cutting item operation.
True if it succeeds, false if it fails.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Gets default cutting side.
The default cutting side.
Gets default cutting side.
The default cutting side.
Sets global information on the given tool class instance.
If non-null, the class.
Fill parameters in the provided LATHETOOL instance using the contained tool data.
Options for controlling the operation.
Query if 'rhs' is similar to this tool.
The right hand side.
Identifier for the machine group.
True to ignore tool number.
True if similar, false if not.
Creates a description.
The offset number.
The new description.
3d tooling cutting parameters for defining what the parameters in a toolpath will default to if requested.
An interface into 3d tooling compensation parameters, or null if not valid for the tool type.
3d tooling cutting parameters for defining what the parameters in a toolpath will default to if requested.
An interface into 3d tooling compensation parameters, or null if not valid for the tool type.
Saves the given setup information to the tool.
True if the spindle direction is CCW.
The active spindle.
The active turret.
True if the tool is vertical.
True if the tool is inverted.
The turret angle.
The home position.
Values that represent orientations.
Values that represent compensation quadrants.
Values that represent compensation methods.
Gets the non cutting boundary.
The non cut boundary.
Gets the cutting boundary.
The cut boundary.
Gets the type of the tool.
True to use custom type, meaning that if custom, the specialization will be
returned (Drill, Groove, etc.).
True to flag custom, meaning that if custom, the custom specialization types will
be used (CustomDrilling, CustomTurning, etc.).
The type.
Gets the type of the tool.
The type.
Values that represent lathe tool types.
For use with tools that have multiple inserts or definitions on a single insert, queries the tool to
identify if there is an alternate insert or definition that satisfies the given predicate, and then
returns an ILTool instance representing a view of that definition.
The predicate to evaluate against.
An ILTool instance representing a view of the first tool definition satisfying the predicate, or nullptr
if one does not exist.
For use with tools that have multiple inserts or definitions on a single insert, creates an alternative ILTool
instance that represents the tool definition with the specified slot number.
The slot number of the definition to create an alternate view of.
The new view of the tool definition that is defined by the alternate slot.
For use with tools that have multiple inserts or definitions on a single insert, queries the tool to identify if
there is an alternative insert or definition at the specified slot number.
The lathe tool slot number.
True if a lathe tool definition exists for the specified slot, false if not.
Gets overall length.
The overall length.
Query if there are multiple inserts defined for this tool assembly.
True if there are multiple inserts defined for this tool, false if not.
For use with tools that have multiple inserts or definitions on a single insert, queries the tool for all tool
definition slots that are represented by this tool, including the currently active one retrieved by a call to
'GetSlot'.
A set of lathe definition slots for this lathe tool.
Makes a deep copy of this object.
A copy of this object.
Inequality operator.
The first instance to compare.
The second instance to compare.
True if the parameters are not considered equivalent.
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.
Equality operator.
The first instance to compare.
The second instance to compare.
True if the parameters are considered equivalent.
Executes the is equal operation.
The right hand side.
True if it succeeds, false if it fails.
Executes the is equal operation.
The right hand side.
True if it succeeds, false if it fails.
Executes the clone operation.
An IToolPtr.
Executes the clone operation.
An IToolPtr.
Fill parameters in the provided op_tool_info instance using the contained tool data.
Options for controlling the operation.
Fill parameters in the provided op_tool_info instance using the contained tool data.
Options for controlling the operation.
Resets the identifiers.
Resets the identifiers.
Creates a description of this tool.
The new description.
Creates a description of this tool.
The new description.
Values that represent active turrets.
Values that represent active turrets.
Values that represent active spindles.
Values that represent active spindles.
Makes a deep copy of this object.
A copy of this object.
Makes a deep copy of this object.
A copy of this object.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlToolThreading tool class type.
Declaration of private deserialization implementation class.
Declaration of private deserialization implementation class.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the get profile parameters operation.
The result profile parameters.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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 calculated minor thread diameter if the there is enough information to calculate it. To be able to
successfully calculate a minor diameter, the tool must be a thread mill with a defined thread form.
For NPT threads, the minimum diameter will be defined WRT the defined cutting diameter. Apply a taper
angle at a height to calculate the minimum diameter for that height.
(Optional) True to get the value in metric, false for inch. Defaults to system
units.
The calculated minimum diameter if available, or nullopt if not.
Gets calculated minor thread diameter if the there is enough information to calculate it. To be able to
successfully calculate a minor diameter, the tool must be a thread mill with a defined thread form.
For NPT threads, the minimum diameter will be defined WRT the defined cutting diameter. Apply a taper
angle at a height to calculate the minimum diameter for that height.
(Optional) True to get the value in metric, false for inch. Defaults to system
units.
The calculated minimum diameter if available, or nullopt if not.
Sets the radius type.
Type of the radius.
Sets the radius type.
Type of the radius.
Gets the corner type.
The corner type.
Gets the corner type.
The corner type.
Sets a thread count.
Number of threads.
Sets a thread count.
Number of threads.
Gets the thread count.
The thread count.
Gets the thread count.
The thread count.
Sets a corner radius.
The corner radius.
Sets a corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Gets the corner radius.
The corner radius.
Sets an operation tool information.
The information.
Sets an operation tool information.
The information.
Default constructor.
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 distance between the top of the tool and the bottom of the holder.
This value is equivalent to tool length - tool machine side connection height, and represents the
positioning distance between the top of the tool and the parent holder's workpiece side connection.
(Optional) True to get value in metric.
The component CScalar value.
Gets the distance between the top of the tool and the bottom of the holder.
This value is equivalent to tool length - tool machine side connection height, and represents the
positioning distance between the top of the tool and the parent holder's workpiece side connection.
The component CScalar value.
Gets the stick-out of the tool from the holder.
This value is equivalent to the tool's machine side connection height. It represents the distance from
the bottom of the holder to the bottom of the tool. In the case of the holder being inside the tool
(e.g. facemill arbor), this value will be the distance between the bottom of the internal holder and
the bottom of the tool. Tool projection in that case will represent the full length of the tool.
True to get value in metric.
The stick-out of the tool with respect to the bottom of the parent holder.
Gets the stick-out of the tool from the holder.
This value is equivalent to the tool's machine side connection height. It represents the distance from
the bottom of the holder to the bottom of the tool. In the case of the holder being inside the tool
(e.g. facemill arbor), this value will be the distance between the bottom of the internal holder and
the bottom of the tool. Tool projection in that case will represent the full length of the tool.
The stick-out of the tool with respect to the bottom of the parent holder.
Updates the tool machine side connection height.
The value.
True if the value is metric.
Updates the tool machine side connection height.
The value.
Gets the maximum tool machine side connection height.
True to get value in metric.
The maximum tool machine side connection height.
Gets the maximum tool machine side connection height.
The maximum tool machine side connection height.
Gets the minimum tool machine side connection height.
True to get value in metric.
The minimum tool machine side connection height.
Gets the minimum tool machine side connection height.
The minimum tool machine side connection height.
Gets the tool machine side connection height.
True to get value in metric.
The tool machine side connection height.
Gets the tool machine side connection height.
The tool machine side connection height.
Updates the tool projection.
The value.
True if the value is metric.
Updates the tool projection.
The value.
Gets the maximum tool projection value.
True to get the value in metric.
The calculated tool projection minimum.
Gets the maximum tool projection value.
The calculated tool projection minimum.
Gets the minimum tool projection value.
True to get the value in metric.
The calculated tool projection minimum.
Gets the minimum tool projection value.
The calculated tool projection minimum.
Gets the Tool Projection.
True to get the value in metric.
The tool projection.
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.
true if similar, false if not.
Determines if the other tool assembly is similar enough to be considered a duplicate.
The other tool assembly.
Identifier for the machine group.
true if similar, false if not.
The external (3rd Party) identifier of the tool assembly
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.
Metric Flag.
Main Holder Identifier.
Main Tool Identifier.
Default Assembly Flag.
Length Offset Number.
Diameter Offset Number.
Machine Group.
Tool Number.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssembly tool class type.
A deserialization implementation.
A deserialization implementation.
Refresh the positioning limits from current tool and holder profiles.
Refresh the positioning limits from current tool and holder profiles.
Gets the full profile of the tool.
True to get profile in metric.
The tool profile result.
Gets the full profile of the tool.
True to get profile in metric.
The tool profile result.
Gets the full profile of the entire holder assembly.
True to get profile in metric.
The holder profile result.
Gets the full profile of the entire holder assembly.
True to get profile in metric.
The holder profile result.
Executes the set main holder action.
Executes the set main holder action.
Executes the set main tool action.
Executes the set main tool action.
Executes the slot changed action.
Executes the slot changed action.
Resets all identifiers associated to this object.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Updates the assembly item described by item.
The item.
Updates the assembly item described by item.
The item.
Gets the assembly item pointer.
Identifier for the item to get.
The assembly item pointer, or nullptr if the item is not found.
Gets the assembly item pointer.
Identifier for the item to get.
The assembly item pointer, or nullptr if the item is not found.
Sets the main holder as null.
This special "Set" overload is necessary because TlHolder has a bool constructor, making a call to
"SetMainHolder" ambiguous if a nullptr is passed in.
The nullptr value.
Sets the main holder as null.
This special "Set" overload is necessary because TlHolder has a bool constructor, making a call to
"SetMainHolder" ambiguous if a nullptr is passed in.
The nullptr value.
Gets machine side connection type.
The machine side connection type.
Gets machine side connection type.
The machine side connection type.
Removes the assembly components.
true if it succeeds, false if it fails.
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 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 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 as default assembly.
The value.
true if it succeeds, false if it fails.
Sets tool number.
The tool number.
Group the machine belongs to.
Sets tool number.
The tool number.
Group the machine belongs to.
Gets the profile of the entire holder assembly from the perspective of an external client.
If a portion of the holder assembly exists contained within the tool (e.g., facemill arbor), that portion
will be truncated from the result.
(Optional) True to get profile in metric.
The holder profile result.
Gets the profile of the entire holder assembly from the perspective of an external client.
If a portion of the holder assembly exists contained within the tool (e.g., facemill arbor), that portion
will be truncated from the result.
(Optional) True to get profile in metric.
The holder profile result.
Gets the Assembly Gauge length
The Gauge Length
Gets the Assembly Gauge length
The Gauge Length
Gets the distance between the top of the tool and the bottom of the holder.
This value is equivalent to tool length - tool machine side connection height, and represents the
positioning distance between the top of the tool and the parent holder's workpiece side connection.
(Optional) True to get value in metric.
The component CScalar value.
Gets the distance between the top of the tool and the bottom of the holder.
This value is equivalent to tool length - tool machine side connection height, and represents the
positioning distance between the top of the tool and the parent holder's workpiece side connection.
(Optional) True to get value in metric.
The component CScalar value.
Gets the stick-out of the tool from the holder.
This value is equivalent to the tool's machine side connection height. It represents the distance from
the bottom of the holder to the bottom of the tool. In the case of the holder being inside the tool
(e.g. facemill arbor), this value will be the distance between the bottom of the internal holder and
the bottom of the tool. Tool projection in that case will represent the full length of the tool.
(Optional) True to get value in metric.
The stick-out of the tool with respect to the bottom of the parent holder.
Gets the stick-out of the tool from the holder.
This value is equivalent to the tool's machine side connection height. It represents the distance from
the bottom of the holder to the bottom of the tool. In the case of the holder being inside the tool
(e.g. facemill arbor), this value will be the distance between the bottom of the internal holder and
the bottom of the tool. Tool projection in that case will represent the full length of the tool.
(Optional) True to get value in metric.
The stick-out of the tool with respect to the bottom of the parent holder.
Updates the tool machine side connection height.
The value.
(Optional) True if the value is metric.
Updates the tool machine side connection height.
The value.
(Optional) True if the value is metric.
Gets the maximum tool machine side connection height.
(Optional) True to get value in metric.
The maximum tool machine side connection height.
Gets the maximum tool machine side connection height.
(Optional) True to get value in metric.
The maximum tool machine side connection height.
Gets the minimum tool machine side connection height.
(Optional) True to get value in metric.
The minimum tool machine side connection height.
Gets the minimum tool machine side connection height.
(Optional) True to get value in metric.
The minimum tool machine side connection height.
Gets tool machine side connection height.
(Optional) True to get value in metric.
The tool machine side connection height.
Gets tool machine side connection height.
(Optional) True to get value in metric.
The tool machine side connection height.
Updates the tool projection.
The value.
(Optional) True if the value is metric.
Updates the tool projection.
The value.
(Optional) True if the value is metric.
Gets the maximum tool projection value.
(Optional) True to get the value in metric.
The calculated tool projection minimum.
Gets the maximum tool projection value.
(Optional) True to get the value in metric.
The calculated tool projection minimum.
Gets the minimum tool projection value.
(Optional) True to get the value in metric.
The calculated tool projection minimum.
Gets the minimum tool projection value.
(Optional) True to get the value in metric.
The calculated tool projection minimum.
Gets the Tool Projection.
(Optional) True to get the value in metric.
The tool projection.
Gets the Tool Projection.
(Optional) True to get the value in metric.
The tool projection.
Gets the max diameter of entire assembly
The max diameter of entire assembly
Gets the max diameter of entire assembly
The max diameter of entire assembly
Gets the total length of all holders
The total length of holders
Gets the total length of all holders
The total length of holders
Gets the mill tool.
The mill tool.
Gets the mill tool.
The mill tool.
Determines if the assembly supports thru coolant.
true if thru coolant is supported, false if not.
Determines if the assembly supports thru coolant.
true if thru coolant is supported, false if not.
Determines if the other tool assembly is similar enough to be considered a duplicate.
The other tool assembly.
(Optional) identifier for the machine group.
true if similar, false if not.
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.
Defines an alias representing the tl assembly entry.
Defines an alias representing the tl assembly entry.
A deserialization implementation.
Executes the get profile operation.
A TlProfileResult.
Executes the on set stored profile operation.
Makes a segment.
The segment.
(Optional) height of the bottom.
(Optional) the color.
A TlProfileSegmentPtr.
Convert profile segment to holder segment.
The profile segment.
The holder segment.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Makes holder segments from profile.
The profile.
A vector of TlHolderSegment.
Makes profile from holder segments.
The holder segments.
A TlProfilePtr.
Gets the length of the holder (max y value - min y value).
The length.
Gets the total Height of the Holder (from y=0 to the holder's max y value).
The Height of the Holder.
Query if this object is default holder.
true if default holder, false if not.
Gets the segments
segments to define the holder
Gets the segments.
The segments.
Adds a segment.
Width of the top.
Width of the bottom.
The height.
true if it succeeds, false if it fails.
Deletes all segments.
true if it succeeds, false if it fails.
Copy operator.
The right hand side.
A deep copy of this object.
Copy constructor.
A deep copy of this object
Parameterized constructor.
true if this object is metric.
Default constructor.
comparison operator.
The other.
true if objects are the same
Class representing an old-style holder segment in the form of a top width, a bottom width, and a height.
Declaration of private deserialization implementation class.
Executes the 'tool length changed' action.
Clean up tools that were created badly in older versions.
True if called from a pre-X8 serialization version
True if called from a pre-X9 serialization version
Executes the get profile operation.
A TlProfileResult.
Old Holder Attributes
Executes the set profile parameters operation.
Options for controlling the operation.
Executes the get profile parameters operation.
The result profile parameters.
Executes the is similar operation.
The other tool.
Identifier for the machine group.
The compare mode.
true if it succeeds, false if it fails.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Sets profile parameters.
Options for controlling the operation.
Gets the profile parameters.
(Optional) True to specifically get parameters in metric, false in inch.
The profile parameters.
Convenience only - No backing field on TlToolMill
The corner radius.
Convenience only - No backing field
The corner radius.
Sets fbm was metric.
true to value.
This is here to support a hack in FBM.
Adjust length for stickout.
The value.
(Optional) True if value is metric.
Resets the projection values.
Sets a tool material code.
The code.
Name of the matl.
Gets the tool material code.
The tool material code.
Sets a canned text coolant.
The coolant.
Gets the canned text coolant data
The canned text coolant data
Sets a pre x coordinate coolant.
The coolant.
Gets the PreX style coolant values (off/flood/mist/spindle).
Tthe PreX style coolant values
Sets the legacy holder data.
The top.
The height.
Sets the mastercam type of this tool.
The value.
Sets mc tool type.
The value.
Returns the mastercam type of this tool.
The Mastercam type of this tool.
Returns a list of the IDs of the op type this tool
supports
The list of op type IDs support by this tool
Adds a supported tool type ID for this tool.
true if the ID was successfully set, false otherwise
Adds a supported op type ID for this tool.
true if the ID was successfully set, false otherwise
Sets the TlToolMill properties located within op_tool_info
true of the setting was successful
Gets operation tool information.
The operation tool information.
Default constructor. Creates an empty tool.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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 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.
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.
A TlOpParams deserialization implementation.
Resets all identifiers associated to this object.
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.
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.
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 canned text coolant.
The value.
Sets pre x coordinate 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.
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 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).
Converts the inputted coolant value to a State index (0, 1, 2).
The value to convert from.
Coolant State (ON, OFF, IGNORE).
Calculates the appropriate value for the given Index, state and time.
[in] field index used in calculations.
[in] state of the field.
[in] timing state of the field.
Result value based off of input.
Calculates the appropriate value for the given Index, state and time.
[in] field index used in calculations.
[in] state of the field.
[in] timing state of the field.
Result value based off of input.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
A serialization implementation forward declaration.
A serialization implementation forward declaration.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the inputted value into an enumeration value.
The value.
The given data converted to a custom coolant position.
Converts the inputted value into an enumeration value.
The value.
The given data converted to a custom coolant position.
Converts the inputted value into an enumeration value.
The value.
The given data converted to a custom coolant state.
Converts the inputted value into an enumeration value.
The value.
The given data converted to a custom coolant state.
Converts the inputted standard coolant status value into an enumeration value.
The value.
The given data converted to an old style status.
Converts the inputted standard coolant status value into an enumeration value.
The value.
The given data converted to an old style status.
Updates from canned txt coolant described by coolant.
The coolant.
Updates from canned txt coolant described by coolant.
The coolant.
Converts this coolant object into the canned txt coolant shorts that Mastercam uses in machine
definitions and posts.
The result of the operation.
Converts this coolant object into the canned txt coolant shorts that Mastercam uses in machine
definitions and posts.
The result of the operation.
Parameterized Constructor.
The old style coolant flag to update from.
Parameterized Constructor.
The old style coolant flag to update from.
Parameterized Constructor.
The coolant vector to update from.
Parameterized Constructor.
The coolant vector to update from.
Sets code from identifier.
Sets code from identifier.
Sets identifier from code.
Sets identifier from code.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Query if 'testID' is a valid material identifier.
Identifier for the test.
true if identifier a valid material identifier, false if not.
Query if '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 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 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 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 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 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 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 defined material.
true if defined material, false if not.
Query if this object is known material.
true if known 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.
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.
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 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.
Paramiterized constructor.
Material code to set the ID based off of.
Default constructor.
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 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.
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.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Determines if the other tool is similar enough to be considered a duplicate.
The other.
(Optional) identifier for the machine group to aid in the comparison.
(Optional) the compare mode.
true if similar, false if not.
Determines if the other tool is similar enough to be considered a duplicate.
The other.
(Optional) identifier for the machine group to aid in the comparison.
(Optional) the compare mode.
true if similar, false if not.
Sets operation tool information.
The information.
Sets operation tool information.
The information.
Gets the operation tool information.
The operation tool information.
Gets the operation tool information.
The operation tool information.
Copy operator.
The right hand side.
A deep copy of this object.
Copy operator.
The right hand side.
A deep copy of this object.
Copy constructor.
A deep copy of this object
Copy constructor.
A deep copy of this object
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
View number for this tool.
true = tool is enabled.
bitwise head numbers.
offset from the first lead tool.
block offset
initial tool direction vector for use with programable c axis.
tool axis vector.
work offset ( used to overide t/c plane value.
0=std, 1=rt angle, 2=comp. angle, 3=drill block, 4 = UST.
tool_attr_head.
Defines the TlToolMill tool class type.
Determines if the other tool is similar enough to be considered a duplciate.
The other.
true if similar, false if not.
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.
true if similar, false if not.
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.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlTool tool class type.
Sets CalcHolderTol property in the specified units.
value to set.
true to specify value is in metric.
Gets CalcHolderTol property in the specified units.
true to get value in metric.
TheCalcHolderTol property.
Holder Tolerance used in silhouette boundary calculation.
Sets CalcTol property in the specified units.
value to set.
true to specify value is in metric.
Gets CalcTol property in the specified units.
true to get value in metric.
TheCalcTol property.
Insert Tolerance used in silhouette boundary calculation.
Direction of Plane 1 normal (true = cut plane normal, false = opposite). Used only with OneCutPlaneSilhouette method/
Sets PlaneOffset2 property in the specified units.
value to set.
true to specify value is in metric.
Gets PlaneOffset2 property in the specified units.
true to get value in metric.
ThePlaneOffset2 property.
Plane offset 2
Sets PlaneOffset1 property in the specified units.
value to set.
true to specify value is in metric.
Gets PlaneOffset1 property in the specified units.
true to get value in metric.
ThePlaneOffset1 property.
Plane offset 1
Boundary generation method
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlBoundaryGenerationParams tool class type.
A stationary component configuration 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.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Sets the tool assembly pointer.
If non-null, the assembly.
Gets a value indicating whether the scalar values in this connection are metric.
True if metric, false if inch.
Gets or sets the vector of accessory items associated to this item.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAccessoryCollection tool class type.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAccessory tool class type.
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.
Is Projection Adjustment Editable
Sets MachineSideProjectionAdjustment property in the specified units.
value to set.
true to specify value is in metric.
Gets MachineSideProjectionAdjustment property in the specified units.
true to get value in metric.
TheMachineSideProjectionAdjustment property.
Machine Side Projection Adjustment
Gets or sets the collection of graphics files associated to this item.
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
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlAssemblyItem tool class type.
Gets or sets the vector of graphics files associated to this item.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlGraphicsFileCollection tool class type.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlGraphicsFile tool class type.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlLocator tool class type.
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.
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 - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Default Constructor.
Defines the TlOpGroup tool class type.
Allocate appropriate managed object based referencing native object.
The underlying native object.
nullptr if it fails, else a managed wrapper object.
Allocates appropriate managed object based referencing native object.
Pointer to native instance.
Track whether Dispose has been called.
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.
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.
Default Constructor.
Constructor - This is for internal use by the API.
This is for internal use by the API.
Native pointer to underlying native object to wrap.
Defines the TlObject tool class type.
Plane marshal.
Information describing the plane.
A Mastercam Plane.
Plane marshal.
A Mastercam Plane.
A Planes::Interop::PlaneInfo.
Marshals the given pointer into a DB_LIST_ENT_PTR.
The value.
A DB_LIST_ENT_PTR result.
DB_LIST_ENT_PTR vector marshal.
The marshalled collection of entity ptrs.
The EptrVector result.
DB_LIST_ENT_PTR vector marshal.
The entity ptrs.
The marshalled collection.
Marshals the given window handle into an HWND.
The window.
The handle of the window.
Marshals the given window handle into an HWND.
The window.
The handle of the window.
Window marshal.
If non-null, the window.
Null if it fails, else a pointer to a CWnd.
Plane information marshal.
Information describing the plane.
A Planes::PlaneInfo.
Plane information marshal.
Information describing the plane.
A Planes::Interop::PlaneInfo.
Vector 3D marshal.
The vect.
A CM::Vector3D.
3D Vector Marshal.
The vect.
A System::Windows::Media::Media3D::Vector3D.
Vector 2D marshal.
The value to marshal.
A CM::Vector2D.
Vector 2D marshal.
The value to marshal.
A System::Windows::Point.
Values that represent custom coolant positions.
An enum constant representing the after option
An enum constant representing the with option
An enum constant representing the before option
Values that represent custom coolant states.
An enum constant representing the ignore option
An enum constant representing the off option
An enum constant representing the on option
Values that represent standard coolant statuses.
An enum constant representing the through tool option
An enum constant representing the mist option
An enum constant representing the flood option
An enum constant representing the off option
Values that represent holder tool types.
An enum constant representing the live center tool option
An enum constant representing the custom geometry tools option
An enum constant representing the drill tap or reamer tools option
An enum constant representing the boring bars option
An enum constant representing the grooving or parting tools option
An enum constant representing the threading tools option
An enum constant representing the general turning tools option
Values that represent insert materials.
An enum constant representing the unknown option
An enum constant representing the diamond option
An enum constant representing the cubic boron nitride option
An enum constant representing the ceramic option
An enum constant representing the cermet option
An enum constant representing the carbide option
Values that represent coolant approach forces.
An enum constant representing the state force option
An enum constant representing the state modal option
Values that represent coolant approach outputs.
An enum constant representing the output separate lines option
An enum constant representing the output one line option
Values that represent tl coolant approach types.
An enum constant representing the coolant type select option
An enum constant representing the coolant type all option
An enum constant representing the coolant type custom option
Values that represent turn holder types.
An enum constant representing the multi function option.
An enum constant representing the parting option.
An enum constant representing the face grooving option.
An enum constant representing the external grooving option.
An enum constant representing the internal grooving option.
An enum constant representing the external threading option.
An enum constant representing the internal threading option.
An enum constant representing the boring bar option.
An enum constant representing the general turning option.
Defines the TlActiveTurret enumeration.
(Lower) Fixed tooling is active.
(Upper) Fixed tooling is active.
Upper right turret is active.
Lower right turret is active.
Upper left turret is active.
Lower left turret is active.
No active turret.
Values that represent spindle speed units.
An enum constant representing the constant surface speed option.
An enum constant representing the revolutions per minute option.
Defines the TlFeedSpeedUnits enumeration.
The feed per minute.
The feed per revolution.
Values that represent 3D Tool Assembly types.
An enum constant representing the grooving option.
An enum constant representing the threading option.
An enum constant representing the turning boring option.
An enum constant representing the undefined option.
Values that represent tool orientation states.
An enum constant representing the horizontal quadrant 4 option.
An enum constant representing the horizontal quadrant 3 option.
An enum constant representing the horizontal quadrant 2 option.
An enum constant representing the horizontal quadrant 1 option.
An enum constant representing the vertical quadrant 4 option.
An enum constant representing the vertical quadrant 3 option.
An enum constant representing the vertical quadrant 2 option.
An enum constant representing the vertical quadrant 1 option.
Values that represent tool compensation positions states.
An enum constant representing the position4 option.
An enum constant representing the position3 option.
An enum constant representing the position2 option.
An enum constant representing the position1 option.
Defines the TlCompensationType enumeration.
Comp to tip of insert radius on C/L.
Comp using tangencies of two tool circles.
Comp to theoretical sharp corner of insert.
Comp to center of insert radius.
Defines the TlActiveSpindle enumeration.
Maximum heads.
Right spindle is active.
Left spindle is active.
Defined methods for calculating the profile from the 3D model.
Cut 3D model between the two planes and then calculate profile from silhouette.
Cut 3D model on one side of plane and then calculate profile from silhouette.
Simple silhouette profile calculated WRT cutting plane normal.
Values that represent the insert definition.
An enum constant representing the ISO option.
An enum constant representing the ANSI option.
Values that represent the handedness of a tool or tool item.
An enum constant representing the symmetric option.
An enum constant representing the left option.
An enum constant representing the right option.
Values that represent tool graphics file formats.
an enum constant representing the Parasolid Transmit memory format option.
An enum constant representing a file format that isn't recognized by the other options.
An enum constant representing the Parasolid Transmit file (X_B) option.
An enum constant representing the STL option.
An enum constant representing the STEP option.
An enum constant representing the JPEG option.
An enum constant representing the PNG option.
An enum constant representing the bitmap option.
Enumeration for radius types
An enum constant representing the Full option.
An enum constant representing the Corner option.
An enum constant representing the None option.
Enumeration for different hardness scales.
An enum constant representing the RockwellC option.
An enum constant representing the RockwellB option.
An enum constant representing the RockwellA option.
An enum constant representing the Brinell option.
Enumeration representing the different material ISO Group Values.
An enum constant representing the H option.
An enum constant representing the S option.
An enum constant representing the N option.
An enum constant representing the K option.
An enum constant representing the M option.
An enum constant representing the P option.
An enum constant representing the Undefined option.
Values that represent the different Thread Shapes.
An enum constant representing a generic undefined thread shape.
An enum constant representing the National Pipe Thread shape..
An enum constant representing the Buttress Push shape..
An enum constant representing the Buttress Pull shape..
An enum constant representing the acme stub shape.
An enum constant representing the acme shape.
An enum constant representing the metric shape.
An enum constant representing the un shape.
Helix type for router tools
Compression Helix.
Down Helix.
Up Helix.
No Helix.
Enumeration for spindle directions.
Static spindle..
Counterclockwise spindle direction..
Clockwise spindle direction..
Values that represent the different shank types on tools.
Reduced Shank.
Tapered Shank.
Straight Shank.
Enumeration that represent TlCornerType.
An enum constant representing the RoundOver option.
An enum constant representing the FullRadius option.
An enum constant representing the Radius option.
An enum constant representing the Chamfer option.
An enum constant representing the None option.
Values that represent the different Lathe Live Center taper styles.
An enum constant representing the brown and sharpe option.
An enum constant representing the jarno option.
An enum constant representing the morse option.
An enum constant representing the straight shank option.
Values that represent the different Lathe Live Center point styles.
An enum constant representing the interchangable option.
An enum constant representing the center extractor option.
An enum constant representing the tracer point option.
An enum constant representing the pipe nose option.
An enum constant representing the carbide tip point option.
An enum constant representing the long point option.
An enum constant representing the bullnose option.
An enum constant representing the standard point option.
Enumeration representing the Tool Display Type
An enum constant representing the CustomStored option.
An enum constant representing the CustomLevel option.
An enum constant representing the CustomFile option.
An enum constant representing the AutoTool option.
Values that represent the different tool types that Mastercam supports.
Oval form Barrel Mill.
Lens-Barrel Hybrid Barrel Mill.
Lens Form Barrel Mill.
Taper Form Barrel Mill.
Barrel Mill.
Thread Mill.
Feed Mill (High speed mill).
Bradpoint Drill.
Engraving Bit.
Block Drill Tool Definition Shell.
Bull Nosed Endmill.
Lollipop Mill.
Taper Mill.
Dove Tail Cutter.
Radius Mill (Roundover Tool).
Slot Mill.
Face Mill.
Chamfer Mill.
Spherical Ball-Nosed Endmill.
Flat Endmill.
Counter Sink.
Counter Bore.
Boring Bar.
Reamer.
Left Handed Tap.
Right Handed Tap.
Standard Drill.
Spot Drill.
Center Drill.
Undefined Tool.
Enumeration representing the Holder Lower Connection Type.
An enum constant representing the EOC option.
An enum constant representing the SYOZ option.
An enum constant representing the DA option.
An enum constant representing the ER option.
An enum constant representing the CHUCK option.
An enum constant representing the OD option.
An enum constant representing the ID option.
Enumeration representing the Holder Upper Connection Type.
An enum constant representing the Generic option.
An enum constant representing the KM option.
An enum constant representing the OD option.
An enum constant representing the CAPTO option.
An enum constant representing the HSK option.
An enum constant representing the ISO option.
An enum constant representing the CAT option.
An enum constant representing the DV option.
An enum constant representing the BT option.
Enumeration for source of cut params.
An enum constant representing the User option.
An enum constant representing the Manufacturer option.
Enumeration for cut quality.
An enum constant representing the Finish option.
An enum constant representing the SemiFinish option.
An enum constant representing the Rough option.
A proxy wrapper for a Cnc::Tool::TlToolAssemblyComponentView shared pointer instance.
A proxy wrapper for a Cnc::Tool::TlToolAssemblyLatheDefView shared pointer instance.
A macro that defines a native class instance proxy.
The class type.
A proxy wrapper for a Cnc::Tool::TlObject shared pointer instance.
Resets all identifiers associated to this object.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
A tool assembly item deserialization implementation.
Executes the is cutting item operation.
True if it succeeds, false if it fails.
Executes the set stored profile action.
Executes the get profile operation.
A TlProfileResult.
Executes the convert units operation.
True to convert to metric, false to convert to inch.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Updates the connection with the matching identifier on this item with the specified connection data.
The connection.
True if it succeeds, false if it fails.
Attempts to get a pointer to the connection on this item with the specified identifier.
Identifier for the connection.
Null if it fails, else the connection pointer.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Query if this tool assembly item is a cutting item.
True if this assembly item is a cutting item, false if not.
Generates the profile of this item. If the item is a parametric item, a parametric profile will be
generated. Otherwise, the item's stored custom profile will be retrieved in the form of a
TlProfileResult instance.
The profile result.
Removes the operation group described by opGroup.
Group the operation belongs to.
true if it succeeds, false if it fails.
Adds an operation group.
Group the operation belongs to.
true if it succeeds, false if it fails.
Sets the stored profile of the item using the given profile. The passed in profile is assumed to be in the
specified units, as it will be scaled as necessary before being set as the stored profile.
The profile in system units to be set as the stored profile of this item.
True if the profile passed in is in Metric units.
Sets the stored profile of the item using the given profile. The passed in profile is assumed to be in
the specified units, as it will be scaled as necessary before being set as the stored profile.
The profile in system units to be set as the stored profile of this item.
True if the profile passed in is in Metric units.
Gets a scaled version of the stored internal profile in the desired units.
true to get profile in metric.
The stored profile.
Gets a scaled version of the stored internal profile in the desired units.
true to get profile in metric.
The stored profile.
Gets the operation groups.
The operation groups.
Move assignment operator.
The right hand side.
A reference to this object.
Assignment operator.
The right hand side.
A reference to this object.
Move constructor.
The other.
Copy constructor.
The other.
Default constructor.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Clears this object to its blank/initial state.
Deletes the connection described by ID from the map.
The Identifier of the connection to delete.
True if it succeeds, false if it fails.
Gets a const pointer to the connection described by id.
The identifier.
Null if it fails, else the connection pointer.
Adds the connection described by value to the map or updates the existing item if a connection with the
same identifier already exists.
The value to add or update.
True if it succeeds, false if it fails.
Query if this object is empty.
True if empty, false if not.
Gets the size.
The size.
Gets the end iterator.
The end iterator.
Gets the begin iterator.
The begin iterator.
Sets the item pointer.
The item .
Resets all identifiers associated to this object.
The map of old identifiers to new identifiers.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
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.
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.
Sets the file data using the path to the Parasolid transmit (.x_b) file.
Full pathname of the file. Must be a Parasolid transmit (.x_b) file.
A connection deserialization implementation.
Executes the reset IDs operation.
The map of old IDs to new IDs.
Executes the is equal operation.
The right hand side.
True if it succeeds, false if it fails.
Serialize this object to the given stream.
The archive.
Converts the object to the specified units.
True to convert to metric, false to convert to inch.
Sets the item pointer.
The item .
Gets the item pointer.
The item pointer.
Gets a value indicating whether the scalar values in this connection are metric.
True if metric, false if inch.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Sets the translation portion of the locator, scaling the input value if necessary.
The value.
True if the value is in metric.
Sets the translation portion of the locator assuming that the value is in system units.
The value.
Gets the translation portion of the locator in the specified units.
True to get the translation portion in metric.
The translation portion of the locator.
Gets the translation portion of the locator in system units.
The translation portion of the locator.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
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 linearization constant.
The profile segments in order from bottom up.
The profile segments in order from bottom up.
A TlProfile deserialization implementation.
A TlProfile deserialization implementation.
Executes the operation to reset identifiers.
The changed identifiers.
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.
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.
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.
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 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 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.
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 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.
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.
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.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Scales the current profile from Inch to Metric or vise versa if needed.
True if the profile is currently in metric units.
True to scale the profile to metric units if needed.
Scales the current profile from Inch to Metric or vise versa if needed.
True if the profile is currently in metric units.
True to scale the profile to metric units if needed.
Transforms the current profile by the given transformation.
The transformation.
Type of the transformation.
Transforms the current profile by the given transformation.
The transformation.
Type of the transformation.
Scales the current profile.
The scale factor.
Scales the current profile.
The scale factor.
Trims any overhang at the end of the profile. This essentially removes horizontal overlapping segments at
the end of the profile and replaces it with a single trimmed horizontal line segment.
Trims any overhang at the end of the profile. This essentially removes horizontal overlapping segments at
the end of the profile and replaces it with a single trimmed horizontal line segment.
Trim or extend to y coordinate value.
The value.
Trim or extend to y coordinate value.
The value.
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 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.
Trim to x coordinate value.
The value.
true to keep lower portion, false to keep the upper portion.
Splits the current profile at the specified y coordinate value.
The value.
The lower portion profile result.
The upper portion profile result.
(Optional) True to add horizontal connectors.
Splits the current profile at the specified y coordinate value.
The value.
The lower portion profile result.
The upper portion profile result.
(Optional) True to add horizontal connectors.
Splits the current profile at the specified x coordinate value.
The value.
The lower portion profile result.
The upper portion profile result.
Splits the current profile at the specified x coordinate value.
The value.
The lower portion profile result.
The upper portion profile result.
Translates the entire profile, so that the lowest point of the profile is at Y=0.
Looks at the endpoints of each segment to determine the amount to translate.
Translates the entire profile, so that the lowest point of the profile is at Y=0.
Looks at the endpoints of each segment to determine the amount to translate.
Translates the entire profile so that the lowest point of the profile is at Y = 'value'.
The value.
Translates the entire profile so that the lowest point of the profile is at Y = 'value'.
The value.
Adds horizontal connectors to the start and endpoint of the profile.
If the point is already at y=0, then no connector is added/needed.
Adds horizontal connectors to the start and endpoint of the profile.
If the point is already at y=0, then no connector is added/needed.
Linearizes this profile into strictly line segments.
(Optional) The chordal deviation tolerance.
Linearizes this profile into strictly line segments.
(Optional) The chordal deviation tolerance.
Sorts the profile.
true if it succeeds, false if it fails.
Sorts the profile.
true if it succeeds, false if it fails.
Cleanup zero length segments.
Cleanup zero length segments.
Determines if we have any line segments on the Y axis.
true if it succeeds, false if it fails.
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.
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.
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 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) true to only get the segments with height.
The number of profile segments with height.
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.
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 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.
Gets the segment at the specified index.
Zero-based index of the segments.
The segment.
Clears the profile.
Clears the profile.
Sets calculate tolerance.
The value.
Sets calculate tolerance.
The value.
Gets calculate tolerance.
The calculate tolerance.
Gets calculate tolerance.
The calculate tolerance.
Gets segment count.
The segment count.
Gets segment count.
The segment count.
Gets internal maximum y coordinate.
The internal maximum y coordinate.
Gets internal maximum y coordinate.
The internal maximum y coordinate.
Maximum y coordinate of this profile.
The maximum y coordinate.
Maximum y coordinate of this profile.
The maximum y coordinate.
Minimum y coordinate of this profile.
the minimum y coordinate.
Minimum y coordinate of this profile.
the minimum y coordinate.
Maximum x coordinate of this profile.
The maximum X coordinate.
Maximum x coordinate of this profile.
The maximum X coordinate.
Minimum x coordinate of this profile.
the minimum 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
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
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
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.
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 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.
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.
Assignment operator.
The right hand side of the assignment operation.
A deep copy of this object.
Copy Constructor.
The profile.
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.
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.
Default constructor. Creates an empty profile.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Executes the trim at x coordinate value operation.
The value.
true to keep lower segment.
A TlProfileSegmentPtr.
Executes the trim at y coordinate value operation.
The value.
true to keep lower segment.
A TlProfileSegmentPtr.
Query if this object is coincident with the Y axis.
true if coincident with y axis, false if not.
Sets to old segment.
The result.
Sets to old segment.
The result.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Gets scaled segment.
The scale factor.
The scaled segment.
Scales this segment.
The scale factor.
Gets rotated segment.
The radians.
The about point.
The rotated segment.
Gets rotated segment.
The radians.
The rotated segment.
Rotates this object about the passed in point.
The radians.
The about point.
Rotates this object.
The radians.
Gets mirrored segment.
true to about y coordinate axis.
The mirrored segment.
Mirrors.
true to mirror about the Y axis, false to mirror about the X axis.
Gets translated segment.
The delta x coordinate.
The delta y coordinate.
The translated segment.
Translates the segment in 2space.
The change to make in X.
The change to make in Y.
Gets transformed segment.
The transformation.
Type of the transform.
The transformed segment.
Transforms the current segment by the given transformation.
The transformation.
Type of the transform.
Gets reversed segment.
The reversed segment.
Validates the quadrant.
true if it succeeds, false if it fails.
Reverses the segment.
Trim at x coordinate value.
The x coordinate.
(Optional) true to keep lower segment.
A TlProfileSegmentPtr.
Trim at y coordinate value.
The y value to trim to.
(Optional) true to keep the lower segment.
A TlProfileSegmentPtr.
Determines if the current segment x coordinate value.
The value.
true if it succeeds, false if it fails.
Determines whether a given segment would have to be trimmed to stay under Y.
Y value to stay under.
true if it needs trimming, else false.
Sets calculate tolerance.
The value.
Gets calculate tolerance.
The calculate tolerance.
Query if this object is coincident with the Y axis.
true if coincident with y axis, false if not.
Gets maximum width.
The maximum width.
Gets top width.
The top width.
Gets bottom width.
The bottom width.
Height of segment.
said height.
Gets the length of this profile segment.
The length.
Gets the end endpoint of this segment.
The end endpoint.
Gets the start endpoint of this segment.
The start endpoint.
Lowest point contained in segment.
Lowest point contained in segment.
Minimum x coordinate.
A double.
Highest point contained in segment.
Highest point contained in segment.
Maximum x coordinate.
A double.
Conversion function.
(Optional) The chordal deviation tolerance.
vector of TlProfileLineSegmentPtr representing this object, linearized.
Cast that converts the given profile segment to a TlProfileEnt.
The result of the operation.
Conversion operator.
prof_ent representing this object.
Constructor.
The segment.
Default constructor.
Values that represent the various possible transformations for a segment.
A TlObject deserialization implementation.
A TlObject deserialization implementation.
A TlObject deserialization implementation.
Executes the accept visitor operation.
The visitor.
Executes the accept visitor operation.
The visitor.
Executes the accept visitor operation.
The visitor.
Executes the accept visitor operation.
The visitor.
Executes the accept visitor operation.
The visitor.
Executes the accept visitor operation.
The visitor.
Executes the clone operation.
A TlObjectPtr.
Executes the clone operation.
A TlObjectPtr.
Executes the clone operation.
A TlObjectPtr.
The identifier.
The identifier.
The identifier.
Executes the slot changed action.
Executes the slot changed action.
Executes the slot changed action.
Executes the reset ids operation.
The map of IDs that have been changed.
Executes the reset ids operation.
The map of IDs that have been changed.
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.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
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.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Resets all identifiers associated to this object.
The map of IDs that have been changed.
Resets all identifiers associated to this object.
The map of IDs that have been changed.
Resets all identifiers associated to this object.
The map of IDs that have been changed.
Resets all identifiers associated to this object.
Resets all identifiers associated to this object.
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 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 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.
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.
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 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 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.
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.
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.
Gets the identifier.
The identifier.
Gets the identifier.
The identifier.
Less-than comparison operator.
The other.
true if the first parameter is less than the second.
Less-than comparison operator.
The other.
true if the first parameter is less than the second.
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.
Inequality operator.
The right hand side.
true if the parameters are not considered equivalent.
Inequality operator.
The right hand side.
true if the parameters are not considered equivalent.
comparison operator.
The other.
true if objects are the same
comparison operator.
The other.
true if objects are the same
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.
Makes a deep copy of this object.
null if it fails, else a copy of this object.
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.
Move assigment operator.
The other.
A shallow 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.
Assignment operator.
The other.
A shallow copy of this object.
Assignment operator.
The other.
A shallow copy of this object.
Move constructor.
The other.
Move constructor.
The other.
Move constructor.
The other.
Copy constructor.
The other tl object.
Copy constructor.
The other tl object.
Copy constructor.
The other tl object.
Default constructor.
Default constructor.
Default constructor.
Measures the amount of overlap (within given radius) between two line segments in 3D wrt the first line segment (A).
I: The first end-point of line segment A.
I: The second end-point of line segment A.
I: The first end-point of line segment B.
I: The second end-point of line segment B.
I: The maximum overlap radius.
O: The first parameter of the overlap interval (corresponding to line segment A).
O: The second parameter of the overlap interval (corresponding to line segment A).
True if overlap is detected.
@par Purpose:
Find the point rotated about a point and a unit directional vector
@param[in] pt 3d point
@param[in] pt0 fixed point
@param[in] axis unit axial vector
@param[in] angle angle of rotation in radians
@return rotated 3d point
@par Purpose:
Find the components of one vector rotated about a unit directional vector
@param[in] v 3d vector
@param[in] axis unit axial vector
@param[in] angle angle of rotation in radians
@return rotated 3d vector
@par Purpose:
Determine if two 3d vectors are parallel
@param[in] v1 First vector
@param[in] v2 Second vector
@return true = parallel, false = non-parallel
@par Purpose:
Find the components of one vector w.r.t. a unit vector
@param[in] v first 3d vector
@param[in] u unit 3d vector
@param[out] perpUVec component of V perpendicular to U
@param[out] dirUVec component of V in direction of U
@par Purpose:
Form a 3d vectors from its x, y, z components
@param[in] x x component
@param[in] y y component
@param[in] z z component
@param[out] pt components set to x, y, and z
@par Purpose:
Form a 2d vector from its x, y components
@param[out] vector components set to x and y
@param[in] x x component
@param[in] y y component
@par Purpose:
Find the angle formed by two 3d vectors
@param[in] vec1 first 3d vector
@param[in] vec2 second 3d vector
@return Angle formed by the vectors (radians);
@par Purpose:
Find the angle formed by a 2d vector
@param[in] vec a 2d vector
@return Angle, in radians, formed by vec (equivalent to [0,360] degrees)
@par Purpose:
Copy a 2d point
@param[out] pt_out The array to copy to
@param[in] pt_in The array to copy from
@par Purpose:
Copy a 2d point
@param[out] pt_out The array to copy to
@param[in] pt_in The point to copy from
@par Purpose:
Project a 2d point onto a line
@param[in] pt The point to project
@param[in] line The line to project onto
@param[out] pr_pt The projected point
@param[out] t The parameter (0 to 1);
@param[out] succf true if line has non-zero length
@par Purpose:
Determines whether a point lies on a line
@return true = pt lies between line's endpoints
@param[in] pt the 2d point in question
@param[in] line the 2d line in question
@par Purpose:
Find the intersection points of two circles whose center and
radius are specified by arc1 and arc2. Return the intersection
points in p1 and p2. Set succf to false if the circles are
concentric or do not intersect. Allow for tangent circles (to
within a distance of tol);
@param[in] arc1 first 2d arc to intersect
@param[in] arc2 second 2d arc to intersect
@param[in] loc_tol maximum allowable distance between arc1 and arc2
@param[out] p1 first intersection
@param[out] p2 second intersection
@param[out] succf true = p1 and p2 are valid
@par Purpose:
Offset a 2d line
@param[in] line The line to offset
@param[in] dist The distance to offset line
@param[in] bias A point to offset line towards
@param[out] line1 line offset by dist
@param[out] succf true if bias does not lie on line
@par Purpose:
New version of gp_ints with the input loc_tol
Find the intersection of a line or arc with a line or arc.
@param[in] object1 2d line or arc
@param[in] object2 2d line or arc
@param[in] bias_pt bias point
@param[in] loc_tol max distance between object1 and object2
@param[out] near_inters intersection closest to bias_pt
@param[out] far_inters intersection furthest from bias_pt
@param[out] succf true = object1 and object2 intersect
@par Purpose:
Determine whether a point is within loc_tol of a finite arc,
based on a distance and angle test.
@return pt lies on arc
@param[in] pt a 2d point
@param[out] arc a 2d arc
@param[in] loc_tol local tolerance for closeness
@par Purpose:
Determine whether a point actually lies on an entity.
@return true = pt lies on ent
@param[in] pt a 2d point
@param[in] entity a 2d entity
@par Purpose:
This method computes the endpoints of a 3d arc
@param[in] arc the arc to analyze
@param[in] mat An nxm matrix
@param[out] ep1 the endpoint corresponding to sa (first endpoint)
@param[out] ep2 the endpoint corresponding to sa_sw (second endpoint)
@par Purpose:
Find the endpoints of a 2d arc
@param[in] arc a 2d arc
@param[out] p1 the endpoint corresponding to sa
@param[out] p2 the endpoint corresponding to sa + sw
@par Purpose:
Find the t parameter on a 2d line given a point
@param[out] t The parameter corresponding to the projected point
@param[in] pt The point to "project"
@param[in] line The line to "project" onto
@par Purpose:
New version of la_ints.
Finds the intersections of a line and an arc
@param[in] line a 2d line to intersect
@param[in] arc a 2d arc to intersect
@param[in] loc_tol maximum allowable distance between line and arc
@param[out] p1 first intersection
@param[out] p2 second intersection
@param[out] succf true = p1 and p2 are valid
@par Purpose:
Intersect two 2d lines
@param[in] l1 The first line
@param[in] l2 The second line
@param[out] inters The intersection point
@param[out] t1 parameter value
@param[out] t2 parameter value
@param[out] succf Success/Fail
Convert value from Inch to Millimeters.
The value in inches.
The value in millimeters.
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.
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 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 NOT metric.
True if the system is not metric; false if it is.
Checks if the working measurement system is english.
True if the system is english; false if it is not.
Checks if the working measurement system is 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.
Macro for allocating an ent structure array 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.
Checks if the working measurement system is NOT english.
True if the system is not english; false if it is.
Conversion assignment operator.
The toolpath entity in 'ent' form.
A reference to this instance.
Conversion constructor.
The toolpath entity in 'ent' form.
Create struct that matches the legacy ent_tp structure. We use a struct instead of using or typedef in
order to preserve the existing use of forward declarations.
Create struct that matches the legacy ent structure. We use a struct instead of using or typedef in
order to preserve the existing use of forward declarations.
A streamlined entity union used to store toolpath entity information only.
The union portion of the Entity. Contains the data for the specific type actually stored in the entity,
as indicated by the entity's id and assoc_id.
A type that is used to just contain the "header" portion of the ent structure.
An empty struct that allows us to construct an "ent header".
DBvars_CH.h
@defgroup controldb_ch1 Control component union type
@{
@}
@defgroup controldb_ch2 Control post union type
@{
@}
@defgroup controldb_ch3 Control type defines
@{
@}
@defgroup controldb_ch5 Control class access types
@{
@}
@defgroup controldb_ch6 File status
@{
@}
@defgroup controldb_ch7 Pop menu selections
@{
@}
@defgroup controldb_ch8 CNCControl errors
@{
@}
@defgroup controldb_ch10 CNCControl file
@{
@}
@defgroup controldb_ch11 Multiple selection defines
@{
@defgroup controldb_ch12 Control init option option
@{
@}
@defgroup controldb_ch13 Control misc option
@{
@}
@defgroup controldb_ch14 Control drill option
@{
@}
@defgroup controldb_ch15 snAddToToolRegister
@{
@}
@defgroup controldb_ch16 snTransOperParams
@{
@}
@defgroup controldb_ch17 snWorkOffsetNumberTPlane
@{
@}
@defgroup controldb_ch18 snWorkCoordinate
@{
@}
@defgroup controldb_ch19 snGetHomePosition
@{
@}
@defgroup controldb_ch20 snRapidDestination...
@{
@}
@defgroup controldb_ch21 snXYlinPlaneControl...\nsnXYbreakArc...
@{
@}
@defgroup controldb_ch22 snMoveEndOption
@{
@}
@defgroup controldb_ch23 snXYcenterType...
@{
@}
@defgroup controldb_ch24 snHelixType
@{
@}
@defgroup controldb_ch25 snThreeAxisFeed, snFourAxisFeed, snFourAxisRotFeed, snFiveAxisFeed, snFiveAxisRotFeed
@{
@}
@defgroup controldb_ch26 snInverseFeed
@{
@}
@defgroup controldb_ch27 snArcCheckEndPointType
@{
@}
@defgroup controldb_ch28 snSubLocationInNC
@{
@}
@defgroup controldb_ch30 snThreadType
@{
@}
@defgroup controldb_ch31 snLeadInType, snLeadOutType
@{
@}
@defgroup controldb_ch32 snRevPosCornerType..., snAuxRevPosReg1...
@{
@}
@defgroup controldb_ch33 snAuxRevModReg1
@{
@}
@defgroup controldb_ch34 snReturnDrill
@{
@}
@defgroup controldb_ch35 snInitAbsoluteMatching
@{
@}
@defgroup controldb_ch36 snRefAbsoluteMatching - snDepthAbsoluteMatching
@{
@}
@}
UBVS control values.
Control Post ID.
Control Component.
Control Base ID.
Control link ent_idn.
Wire NC path values.
Wire nocore.
Wire 4 axis.
Wire reverse auxiliary.
Wire reverse.
Wire corners.
Wire cuts.
Wire leads.
Machine Cycles.
Lathe canned cycles.
Drill cycles.
General canned cycle.
General NC path values.
Subprograms.
Cutter compensation.
Feed.
Rotary.
Arc.
Linear.
Tool.
Work system.
NC Output.
NC Dialog Wire.
NC Dialog Lathe.
NC Dialog Router.
NC Dialog Mill.
Post file list element.
Files Common
Communication.
Tolerances
Tolerance settings for posting, 'var' are MP variables.
@}
@}
@defgroup pass-specific_data PASS-SPECIFIC DATA
@{
@defgroup non-pass-specific_data NON-PASS-SPECIFIC DATA
@{
Wire change at point structure
Wire control settings change structure
Wire control flag change structure
event entity
feed type event
feed rate event
part rotary axis master event
part spindle speed master event
stock transfer event
tool change event
macro event
axis clamp event
quill event
steady rest advance/retract event
axis place holder event
axis motion event
coolant place holder event
coolant event
hidden tool change marker event
sync event
manual entry event
bar feed event
spindle move event (part spindle)
tool grip length move event
tool clearance move event
tool linear move event
part spindle grip length move event
part spindle clearance move event
chuck open/close event
tool offset event
tool stage event
tool call event
tool spindle orientation event
part spindle orientation event
tool spindle speed clamp event
part spindle speed clamp event
tool spindle speed event
part spindle speed event
dwell event
custom event (canned text)
tool spindle rpm/css
tool spindle event with states
part spindle direction event
part spindle rpm/css
part spindle event with states
select event
select event
comment output event
bar puller open/close
tool table event
event with multiple states, like on/off
part spindle event
simple event
For tool item id
For MT machine position data
event list header event
View Entity Structure.
WCS Information Structure.
@defgroup block_types Block Types
@{
@}
@defgroup head_types Head Types
@{
@}
lathe tool types
for tp_ent type
Named View Associative Geometry Selections.
Tool station.
Tool block component parameters.
Tool heads
Tool head component parameters.
@}
@par Purpose:
Sets the main level number global "main_level". Note: unless temporarily set and restored, do not set "main_level" directly, use this function instead!
@param[in] level level number
@defgroup math_varuables math variables
*
* initialized in this module
Maximum number of views
Defines an alias representing list of leaders.
5ax abbreviated nci entity - definition
@}
nci entity - definition
mill nci - mark start/end of NCI display section
mill nci - contour start section marker (used in contour temp file)
mill nci - pocket start/end keep tool down move marker (used in pocket temp file)
mill nci - pocket start section marker (used in pocket temp file)
wire nci - nocore start section marker (used in pocket temp file)
mill nci - mark start/end of cut/pass
nci - part info
nci - sheet change marker
start of operation output for the post
Note: The start of transform op is not marked but the
start of transformed ops within the transform op are marked.
mill nci - end of operation's nci section
@}
@defgroup nci_start nci - start of operation's nci section
@{
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - unused
event bnci - feed type
event bnci - feed rate
event bnci - tool spindle rpm/css
event bnci - part spindle rpm/css
event bnci - work shift select
event bnci - work offset select
event bnci - drill cancel
event bnci - drill reference
event bnci - axis clamp select
event bnci - rtcp select
event bnci - reference return select
event bnci - polar cylinder select
event bnci - cutter comp select
event bnci - plane select
event bnci - abs/inc select
event bnci - unit select
event bnci - motion select
event bnci - comment output
event bnci - tool table
event bnci - tool stage
event bnci - tool call
event bnci - tool offset
event bnci - a axis motion place holder
event bnci - tool change approach place holder
event bnci - b axis motion place holder
event bnci - axis motion place holder
event bnci - tool change event list end
event bnci - tool change event list start
event bnci - stock transfer
event bnci - custom (canned text)
event bnci - manual entry
event bnci - join token
This is only used in the toolpath simulation, it is not passed to the post
event bnci - macro end
event bnci - macro start
event bnci - macro else
event bnci - transform subprogram marker
event bnci - join
event bnci - hidden part rotary axis master event
event bnci - part rotary axis master event
event bnci - hidden part spindle speed master event
event bnci - part spindle speed master event
event bnci - hidden tool change marker event
event bnci - sync event
event bnci - part spindle stock grip length move
event bnci - part spindle stock clearance move
event bnci - part spindle advance/retract
event bnci - bar puller stock grip length move
event bnci - bar puller stock clearance move
event bnci - tool linear 3d (mill)
event bnci - tool stock clearance move 2d (lathe)
event bnci - tool linear 2d
event bnci - bar feed
event bnci - bar feed lock/unlock
event bnci - steady rest advance/retract
event bnci - steady rest roller lock/unlock
event bnci - steady rest pin advance/retract
event bnci - steady rest open/close
event bnci - tailstock quill retract
event bnci - tailstock quill advance
event bnci - tailstock quill lock/unlock
event bnci - tailstock retract
event bnci - tailstock advance
event bnci - tailstock pin advance/retract
event bnci - tailstock lock/unlock
event bnci - axis motion
event bnci - dwell
event bnci - tool spindle air blast on/off
event bnci - tool spindle orient
event bnci - tool spindle speed clamp
event bnci - tool spindle live spindle enable/disable
event bnci - tool spindle direction with coolant
event bnci - tool spindle direction
event bnci - tool spindle speed
event bnci - part spindle rpm from css
event bnci - part spindle air blast on/off
event bnci - part orient
event bnci - part spindle sync on/off
event bnci - part spindle speed clamp
event bnci - part spindle mill axis enable/disable
event bnci - part spindle direction with coolant
event bnci - part spindle direction
event bnci - part spindle speed
event bnci - part catcher advance/retract
event bnci - eject pin advance/retract
event bnci - bar puller open/close
event bnci - chuck open/close
event bnci - retract coolant place holder
event bnci - approach coolant place holder
event bnci - coolant
event bnci - program stop
event bnci - event list header event
event bnci - tool change retract event list
event bnci - tool change approach event list
@defgroup custom ops event bnci lines
@{
event bnci - custom op event list
nesting nci - miscellaneous parameters #2
nesting nci - miscellaneous parameters #1
wire nci - Agie data
wire nci - stock to leave
lathe nci - tool definition - custom tool geometry file name
lathe nci - tool definition - tool holder parameters
lathe nci - tool definition - tool holder name
lathe nci - tool definition - drilling tool parameters (cutting)
lathe nci - tool definition - drilling tool parameters (geometry)
lathe nci - tool definition - grooving/parting insert parameters
lathe nci - tool definition - threading insert parameters
lathe nci - tool definition - general turning/boring insert parameters
lathe nci - tool definition - tool insert general parameters
lathe nci - tool definition - tool insert name
lathe nci - tool definition - tool geometric parameters
lathe nci - tool definition - tool general cutting parameters
lathe nci - tool definition - tool programming parameters
multiaxis comp in control value
mill nci - matl comment
mill nci - matl name
mill nci - wcs comment
mill nci - wcs name
mill nci - tpln comment
mill nci - tpln name
mill nci - cpln comment
mill nci - cpln name
mill nci - tool definition - custom parameters
mill nci - tool definition - head parameters
mill nci - tool definition - holder parameters
mill nci - tool definition - mill type tool specific parameters
mill nci - tool definition - drill type tool specific parameters
mill nci - tool definition - tool parameters
mill nci - tool definition - chuck name
lathe nci - tool definition - manufacturer
mill nci - tool definition - manufacturer
lathe nci - tool definition - tool comment (name)
mill nci - tool definition - tool comment
lathe nci - tool definition - mc7 path for custom tool geometry
mill nci - tool definition - mc7 path for tool reference
mill nci - operation parameters
tool inspection comment
machine group name
machine group comment
machine name
lathe nci - version, date and geometry file name
mill nci - version, date and geometry file name
mill nci - miscellaneous int - make sure mill/lathe/wire stay same size!
mill nci - miscellaneous reals - make sure mill/lathe/wire stay same size!
lathe nci - construction plane 3x3 matrix
lathe nci - stock description
Mill/Router nci - Multi head, block, station info part 2
Mill/Router nci - Multi head, block, station info part 1 -block tools/drills/aggregates
wire - canned text
lathe - canned text
lathe nci - working coordinate system
mill nci - working coordinate system
mill - canned text
mill nci - stock description
mill nci - stock description
All but wire nci - end of sub program section.
This structure must match the types from nci_mill_1018 because code uses these interchangeably.
See comments with nci_mill_1018.
All but wire nci - start of sub program section.
The structure is context and process dependent. See comments.
mill nci - construction plane 3x3 matrix
wire nci - associative params - make sure mill/lathe/wire stay same size!
lathe nci - associative params - make sure mill/lathe/wire stay same size!
mill nci - associative params - make sure mill/lathe/wire stay same size!
wire nci - subroutine parameters
lathe nci - tool plane 3x3 matrix
mill nci - tool plane 3x3 matrix
wire nci - miscellaneous params - make sure mill/lathe/wire stay same size!
lathe nci - miscellaneous params - make sure mill/lathe/wire stay same size!
mill nci - miscellaneous params - make sure mill/lathe/wire stay same size!
wire nci - miscellaneous int - make sure mill/lathe/wire stay same size!
lathe nci - miscellaneous int - make sure mill/lathe/wire stay same size!
mill nci - miscellaneous int - make sure mill/lathe/wire stay same size!
wire nci - miscellaneous reals - make sure mill/lathe/wire stay same size!
lathe nci - miscellaneous reals - make sure mill/lathe/wire stay same size!
mill nci - miscellaneous reals - make sure mill/lathe/wire stay same size!
wire nci - control settings change
wire nci - wirepath length
wire nci - operation comment
lathe nci - operation comment
mill nci - operation comment
wire nci - comment (manual entry)
lathe nci - comment (manual entry)
mill nci - comment (manual entry)
wire nci - cancel cutter comp in control
lathe nci - cancel cutter comp in control
mill nci - cancel cutter comp in control
wire nci - end of file
lathe nci - end of file
mill nci - end of file
wire nci - start of nci file and/or tool change
lathe nci - start of nci file and/or tool change
mill nci - start of nci file and/or tool change
for rent
alternate turret position flag (turret lathe)
tool number
tool station number
ATC tool pocket, turret index position, gang tool = station
ent_idn of tool changer component
tool changer type:
ATC_COMPONENT, TURRET_COMPONENT, MT_TURRET_COMPONENT, GANG_TOOL_COMPONENT
nci enhanced tool change information
lathe nci - axis combination
MT steady rest (standalone) operation
turret operation
tailstock operation
spindle sync operation
spindle advance/retract operation
chuck clamp/unclamp operation
bar feed operation
bar feeder on/off
bar puller open/close
lathe nci - miscops custom integer parameters
lathe nci - miscops custom real parameters
lathe nci - turret park operation - obsolete
lathe nci - steady rest position operation
lathe nci - tailstock position operation
lathe nci - chuck clamp/un-clamp, reposition operation
lathe nci - stock bar feed operation
lathe nci - stock flip operation
lathe nci - stock transfer operation
lathe nci - start of threading cycle
lathe nci - threading cycle
wire nci - canned cycle point position
mill nci - canned cycle point position
nci - drill block parameters
wire nci - start canned cycle
lathe nci - start canned cycle
lathe nci - custom drill parameters
mill nci - custom drill parameters
mill nci - start canned cycle
wire nci - cancel canned cycle
lathe nci - cancel canned cycle
mill nci - cancel canned cycle
wire nci - 4axis direct arc XY or UV move (gcodes 22, 23, 32, 33)
wire nci - 4axis direct linear XY or UV move (gcodes 20, 21, 30, 31)
wire nci - 4axis longhand
Lathe nci 5 axis move.
mill nci - 5 axis move
wire nci - dwell
mill nci - dwell
mill nci - dwell
wire nci - arc feed move
lathe nci - arc feed move
mill nci - arc feed move
lathe nci - linear feed move
mill nci - linear feed move
wire nci - rapid or feed move (depends on gcode 0 or 1)
mill nci - rapid move
for linked lists of operation entities
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
Equality operator.
The first instance to compare.
The second instance to compare.
true if the parameters are considered equivalent.
operation parameter definition
* @note If a operation member is added between version and u and the new
* member is not supposed to be part of the operation header, the define
* below must be changed to use the new member in place of u.
operation parameters - multiaxes smoothing parameters
For Override Arc Feedrate on Arc Filter / Tolerance page.
For arc fit parameters on linking page.
operation parameters - Feedrate optimization
operation parameters - common rotary parameters
c-axis = polar conversion (3 axis)
y-axis = toolplane positioning (rotary positioning)
operation parameters - common toolpath display parameters
operation parameters - contour lead in-out parameters
operation parameters - contour entry-exit parameters
operation parameters - home position
operation parameters - pocket and contour multi cuts
operation parameters - pocket and contour depth cuts
operation parameters - tool and construction planes
operation parameters - cutter comp
operation parameters - cutter comp in control
operation parameters - cutter comp in computer
operation parameters - toolpath filter settings
operation parameters - more room
operation events
operation parameters - canned text
auxiliary file name - mill:msurf recut file, wire:material library
operation parameters - common parameters for all mill operation types
Values that represent the offsets of the bits in the bitmask, op_common.graphicalPreviewFlags.
Values that represent reference point types.
operation parameters - database info
Lathe b-axis contour turning parameters.
Lathe b-axis contour turning angle control parameters.
Lathe b-axis contour turning depth parameters.
Lathe b-axis contour turning advanced parameters.
MT steady rest point parameters.
MT steady rest parameters.
Given a linked components ids struct count the number of non-zero ids.
Linked component ids struct.
Linked component ids count.
Equality operator.
The right hand side.
true if the parameters are considered equivalent.
Component ids of linked components.
Steady rest POCO move/operation types.
Thread custom parameters.
Thread custom common rough and finish parameters.
Thread custom retract motion parameters.
Thread custom tool inspection parameters.
Thread custom allowance parameters.
Thread custom multi-start parameters.
Thread custom finish parameters.
Thread custom finish depth parameters.
Thread custom rough parameters.
Thread custom rough depth parameters.
Thread custom rough step parameters.
Thread custom shape parameters.
Thread custom parametric shape parameters.
Thread Custom toolpath parametric trapezoidal shape parameters.
Thread Custom toolpath parametric rope shape parameters.
Thread Custom toolpath parametric buttress shape parameters.
Thread Custom toolpath parametric square shape parameters.
Lathe thread overcut parameters.
Lathe thread acceleration clearance parameters.
Lathe thread pitch parameters.
Lathe entry and exit parameters.
Lathe entry or exit parameters.
Lathe feed rate parameters.
Lathe stock to leave parameters.
Lathe stock to leave parameters struct.
Values that represent parametric groove shape types.
Values that represent thread acceleration clearance type.
Values that represent multi start cut order types.
Values that represent lathe distance types.
Values that represent lathe spindle speed types.
Values that represent tool inspection locations.
Values that represent thread custom cut order.
Values that represent thread custom rough depth types.
Values that represent thread custom rough step types.
Values that represent thread pitch types.
Values that represent thread orientations.
Operation parameters - stock model.
Defines an alias representing the plane pointer.
Map definition for this plane's associated entity information.
Gets the associated entity information contained in this plane.
(Optional) True to warn for bad solid data.
The associated entity information.
Constructor.
Origin or Matrix.
Information describing the associated entity.
Inequality operator.
The object to compare.
True if the parameters are not considered equivalent.
Equality operator.
The object to compare.
True if the parameters are considered equivalent.
Information about the plane's associated entity links.
Calculate the transformation matrix between given matrix and origin and TOP and transform this plane by that amount.
3x3 matrix to subtract from this.
Point in world coordinates to subtract from this.
Calculate the transformation matrix between given plane and TOP and transform this plane by that amount.
Plane to subtract from this.
Calculate the transformation matrix between TOP and given matrix and origin and transform this plane by that amount.
3x3 matrix to add to this.
Point in world coordinates to add to add to this.
Calculate the transformation matrix between TOP and given plane and transform this plane by that amount.
Plane to add to this.
Calculate the transformation matrix between TOP and given matrix and origin and transform this plane by
that amount.
3x3 matrix to add to this.
Point in world coordinates to add to add to this.
True to add, false to subtract.
True if it succeeds, false if it fails.
Inverse transform matrix and origin.
The transform.
The 3x3 matrix.
The world origin point.
Calculate the transformation matrix between to views and origins.
Source view.
Source origin in world coordinates.
Destination view.
Destination origin in world coordinates.
transformation matrix.
See if m_CreationMethod requires geometry.
true if it it does, false if it doesn't.
Initialize an op_view to the contents of this plane.
op_view to initialize.
A reference to a MastercamPlanes objcet to get the view # from.
true = set op_view.woff_n, false = maintain current op_view.woff_n value.
return true if successful.
Check our parameters.
A reference to a MastercamPlanes object to get the view #'s from.
(Optional) Ignore these parameters.
(Optional) The geometry map.
Return pair, first=Error code mask, second=true=plane was updated.
set m_RegenErrors from constructor values.
returns true if okay.
create and draw the Plane's icon in the screen background color.
Create and draw the Plane's gnomon in its native color.
true to include the plane name.
(Optional) true if plane planel active and plane selected (default = false).
(Optional) true to draw as enabled; false to draw as disabled (default = true).
Create a PlaneGnomon for this plane in m_spGnomon.
true to single instance.
true if it succeeds, false if it fails.
Return const pointer to m_spGnomon.
The gnomon pointer.
set regeneration errors.
error mask to add.
return previous error values.
Regenerate if we're a linked plane.
A reference to a MastercamPlanes object to get our
parent plane we're linked to.
True = dont update origin or matrix.
True if it succeeds, false if it fails.
Regenerates us to our associated entities.
A reference to a MastercamPlanes object to get the
view #'s from.
True = dont update origin or matrix.
(Optional) Pointer to a geometry map. If nullptr,
we'll create one but it's expensive to do so.
[0] = true if matrix updated [1] = true if origin updated [2] = additional
transformation applied.
Compares the given origin with our m_Origin to detect changes.
The origin to compare with m_Origin.
The comparison information.
Values that represent plane origin information.
Determines if we should NOT apply any additional transformation to the origin during
regneration.
True if origin should have any additional transformation stored in m_Transform
applied when being regenerated, false if it should.
Regenerates us to our associated geometry.
A reference to a MastercamPlanes object to get the
view #'s from.
True = dont update origin or matrix.
(Optional) Pointer to a geometry map.
(Optional) True = Remove plane's associativity if it's not valid.
True if it succeeds, false if it fails.
Get's the largest difference of any of the coordinates in the matrix or origin.
The matrix to compare ours with.
The origin to compare ours with.
A pair with first = the largest difference, second = difference position in the origin or matrix.
Calls DebugPlaneStr() with the difference of this plane's matrix/origin with the
given ones.
The matrix to compare ours with.
The origin to compare ours with.
True to show the debug dialog, false to not.
True if there is a difference, false if not.
Calls DebugPlaneStr() with this plane's name.
The message.
Allocates for a plane based on type.
The plane class (SystemMatrix, NamedPlane, etc).
(Optional) ptr to plane to copy.
Base class ptr to newly allocated plane.
Convert a point in plane coordinates to world coordinates (map from plane's view, add the plane origin).
The point in plane coordinates.
P3D of world point relative to the plane's view and origin.
Convert a point in world coordinates to plane coordinates (map to plane's view, subtract the plane origin).
The point in world coordinates.
P3D of world point relative to the plane's view and origin.
Return value of m_Temporary.
true if it succeeds, false if it fails.
Set m_Temporary.
if true, temporary plane will not be listed in Planes Manager and will be deleted on file/save.
return previous value.
Gets the lparam.
Return value of m_Lparam.
Set optional user value.
value to set.
Previous value.
Increment or decrement ent.vw_refs in associated entities. Should only be called if in the current db.
true = increment, false = decrement.
return # of entities updated.
Increment or decrement ent.vw_refs in associated entities. Should only be called if in the current db.
true = increment, false = decrement.
reference to geometry entities eptr/ID map, NULL will create one if regenerate is set to true.
return # of entities updated.
Gets constructor method.
The constructor method.
return CString of m_RegenErrors.
The regen error string.
return value of m_RegenErrors.
The regen errors.
Call up dialog to define new origin point for this plane.
true = ask to associate with new geometry, false
= do it.
Erase plane icon on dialog startup, draw icon on
dialog exit.
true if we are editing an existing plane. False otherwise.
[in,out] (Optional) CWnd to parent window of
dialog.
editingExistingPlane is only relevant if askToAssociateWithNewGeometry is true
returns a pair: first = OriginSelection type, second = if Plane.m_Transform was
updated.
swap old entity ID for new ID.
the old entity ID.
the new entity ID.
true = mark plane dirty if any ID's were swapped.
returns # of ID's swapped.
Erase the Plane's from the graphics window.
Create and draw the Plane's wireframe icon in its native color.
(Optional) true to force drawing (ignore m_DisplayMode).
(Optional) true to include the plane name (default = true).
(Optional) true if plane planel active and plane selected (default = false).
(Optional) true to draw as enabled; false to draw as disabled (default = true).
Convert this plane to an X6 op_view structure without overriding the op_view's work offset value.
reference to X6 op_view structure to fill in.
A reference to a MastercamPlanes object to get the view # from.
true if it succeeds, false if it fails.
Convert this plane to an X6 op_view structure.
reference to X6 op_view structure to fill in.
A reference to a MastercamPlanes object to get the view # from.
true if it succeeds, false if it fails.
Convert this plane to an X6 group_view structure.
reference to X6 group_view structure to fill in.
Convert this plane to an X6 view_ent structure.
reference to X6 view_ent structure to fill in.
A reference to a MastercamPlanes object to get the view # from.
Convert this plane to an X6 view_ent structure.
reference to prm_xform_view structure to fill in.
remove association between a plane and any entity.
Remove geometry association for the origin, matrix or both.
True to delete from associated ent (Solid or mesh), false just zero out association info in this plane.
(Optional) True to reset the extra transform information.
True if it succeeds, false if it fails.
Removes any link to another plane.
The previous link (plane ID).
validate relative plane type.
relative plane (RelativeType::Front, etc)
return true if relative type is valid.
Validate coordinate display mask (lathe or mill).
coordinate display mask type.
return true if valid.
Validate coordinate display type.
coordinate display type.
return true if valid.
return true if the plane can be edited (not reserved, etc)
the Plane to check.
true = check if lock is on.
true if the plane can be edited.
Compare oldPlane against newPlane to determine if the change can affect a toolpath operation.
New plane values.
true if a member variable's change will affect a toolpath operation, false if it won't.
Compare given plane to this, return true if differences are great enough to require a
regeneration of this plane (i.e. matrix or origin changed, but not name, etc).
The plane to compare.
Returns mask (COMPARISON_MATRIX, etc).
Check if this plane is parallel to given view #.
SystemMatrix to compare with this.
[in,out] reference to bool will be set to true if Z component is in the opposite direction.
(Optional) true = allow opposite Z component check, false = all opposite Z component views are ignored.
Return true if parallel.
Check if entity ID is used in this plane.
Entity IDs to check for.
return true if any entity ID in the given set is associated with this plane.
Check validity of plane type.
PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE.
(Optional) debug only warning.
Return false if any other value was given in whichPlane.
Get plane ID of the plane this plane is linked to.
Return the ID of the plane this plane is linked (dependent) to, 0 if not linked.
get the Plane's linking info (RelativeType::Front, etc), transform data
The linking info.
return true if we are associated to geometry.
What type of association are you checking?.
true if association found, false if not.
Query if this object contains lathe coordinate display.
true if lathe coordinate display, false if not.
return true if this plane is a reserved plane, false if it is not.
return true if this plane is a reserved plane, false if it is not.
validate Plane creation method.
int representing creation method (CreationMethod::ThreePoints, etc)
returns true if valid.
Return true if this plane is TOP at an origin of X0 Y0 Z0.
true if top at zero, false if not.
Return true if this plane's matrix and origin match given plane's matrix and origin.
a plane to compare this to.
(Optional) true = debug only warning if not equal.
return true if equal within plane tolerance.
Return true if this plane's matrix and origin match given matrix and origin.
3x3 matrix to compare.
origin point in world coordinates to compare.
(Optional) true = debug only warning if not equal.
return true if equal within plane tolerance.
calculate 3D intersection point within the given view for 2 entities.
view to calculate intersection in.
entity 1 of 2.
entity 2 of 2.
2D selection point near entity 1.
2D selection point near entity 2.
2D t value point for entity 1.
calculated intersection point.
returns true if parallel.
determine if the 2 given lines are parallel.
line 1 of 2.
line 2 of 2.
returns true if parallel.
determine the normal of the plane for two 3d lines.
reject these lines (return false) if they do not lie in the same plane.
line 1 of 2.
line 2 of 2.
normal of the plane that line0 and line1 lie in.
returns true if flat.
calculate a 3x3 matrixm view # and intersection point from 2 lines.
line 1 of 2.
line 2 of 2.
calculated 3x3 matrix.
calculated intersection point.
returns true if successful.
calculate a 3x3 matrix from 2 lines.
line 1 of 2.
line 2 of 2.
calculated 3x3 matrix.
returns true if successful.
convert 3 points into 2 lines and calculate a 3x3 matrix and an intersection point.
point 1 of 3.
point 2 of 3.
point 3 of 3.
calculated 3x3 matrix.
calculated intersection point.
returns true if successful.
rotate a Matrix33 about an axis by degrees.
rotation amount in degrees.
the X, Y or Z axis to rotate about.
the Matrix33 to rotate.
returns true if successful.
rotate a Matrix33 by relative type.
A reference to a MastercamPlanes object to get the view #'s from.
[in,out] the Matrix33 to rotate.
the relative type (RelativeType::Front, etc)
returns true if successful.
Multiply this plane's matrix by the given matrix.
a Matrix33 object to multiple this by.
Multiply two 3x3 matrices.
a Matrix33 object.
a Matrix33 object.
the destination Matrix33 object ( m1 * m2)
Sets new matrix, origin and transform after removing old transform.
The Plane's new 3x3 matrix.
The Plane's new origin point in world coordinates.
returns true if successful.
Transform this plane by the given transformation matrix.
valid transformation matrix.
transform plane origin too.
If true, the transform is only applied if the plane is associated in origin or in orientation.
(optional) if true, result matrix is initial plane matrix * transformation matrix.
Otherwise, result matrix is transformation matrix * initial plane matrix.
True if it succeeds, false if it fails.
Rotates an existing non-reserved, non-locked plane.
The axis to rotate about (X=0, Y=1, Z=2).
The rotation angle in degrees.
true if it succeeds, false if it fails.
Transform this plane by a relative plane.
A reference to a MastercamPlanes object to get the view #'s from.
RelativeType::Front, RelativeType::Back, etc.
Calculate the transformation matrix between to views and origins for bnci purposes.
Source view.
Source origin in world coordinates.
Destination view.
Destination origin in world coordinates.
[in,out] Reference to transformation matrix to fill in.
Return true if calculation successful and contents of xm is valid.
Transform this for bnci purposes.
The transformation.
True to do origin.
True if it succeeds, false if it fails.
Calculate the transformation matrix between to views and origins.
Source view.
Source origin in world coordinates.
Destination view.
Destination origin in world coordinates.
Return transformation matrix.
Transform a matrix and origin.
The transform.
[in,out] The matrix to transform.
[in,out] The world origin point to transform.
(optional) if true, result matrix is initial plane matrix * transformation matrix.
Otherwise, result matrix is transformation matrix * initial plane matrix.
Sets the values in m_Link.
Information describing the dependency.
Previous value of m_Link.
Inverse transform by m_Transform.
Previous value of m_Transform.
Sets our transform in m_Transform.
The transformation matrix.
Previous value of m_Transform.
Initializes the m_Transform.
(Optional) Which parts of the additional transformation do you want
to initialize? Default = both matrix and origin.
Previous value of m_Transform.
Copy data that can be changed in a reserved Plane.
The plane to copy from.
Set plane's dirty flag.
true = dirty (requires regneration), false = clean.
return previous value.
Sets coordinate display for all constructors.
This will be the default coordinate display value assigned to the Plane's upon instantiation.
CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD.
true if it succeeds, false if it fails.
Set the plane's coordinate display mode.
CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD.
return previous value, -1 if invalid coordinateDisplay.
set the Plane's ouput comment to NCI mode.
true = ouput Plane's comment to NCI.
returns previous value.
set the Plane's comment string.
a comment.
returns previous value.
set display (whether it will be drawn) to on or off.
1 = on, 0 = off.
returns previous value.
set the Plane's origin.
the Plane's new origin in world coordinates.
true = remove info to associated geometry.
returns previous value.
set the Plane's origin.
the Plane's new origin in world coordinates.
returns previous value.
Values that represent the return value of SelectOriginPoint ().
set the Plane's 3x3 matrix (m_33)
the Plane's new 3x3 matrix.
returns true if successful.
Set the plane type.
PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE.
Return previous value.
set Plane relative to a WCS.
a Plane ID (whatever the active WCS was at the time of setting)
returns previous value.
set the Plane's color.
the Plane's color.
returns previous value.
set the Plane's work offset value.
the Plane's work offset value.
returns previous value.
set the Plane's name.
the Plane's name.
returns true if successful.
set the Plane's points and selected entity info used in it's definition.
array of point info.
returns size of array.
set the unique ID of the plane.
the new ID.
(Optional) Info of the dependent parent plane.
return the previous value of the ID.
set the version.
The version.
return the previous version value.
set selected flag.
true = selected.
return previous value of selected flag.
set the creation method.
int representing creation method (CreationMethod::ThreePoints, etc)
returns previous value.
Sets the value of m_SectionView.
true = used as a section view.
The previous value of m_SectionView.
Casts the Plane pointer from a PlaneBasePtr to a Plane * if the class is PlaneClass::NamedPlane.
The base.
nullptr if it fails, else a valid Plane *.
Casts the Plane pointer from a PlaneBasePtr to a Plane * if the class is PlaneClass::NamedPlane.
The base.
nullptr if it fails, else a valid Plane *.
return the value of the 'dirty-needs regeneration' flag.
return the value of the 'dirty-needs regeneration' flag.
return true if coordinate display and mask match value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD)
plane coordinate display filter (COORD_MASK_MILL, COORD_MASK_LATHE_X, COORD_MASK_LATHE_D or COORD_MASK_ALL)
return true if coordinate display and mask match value.
get the active coordinate display description.
CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD.
return description.
Gets coordinate display mask from the coordinate display value of this.
The coordinate display mask.
return correct mask value for coordinate display value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD)
The coordinate display.
The coordinate display mask.
return coordinate display value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD)
The coordinate display.
return icon display mode (0=off, 1=on)
The display mode.
return comment output to NCI value.
return comment output to NCI value.
get the Plane's comment string.
returns the Plane's comment string.
Collect all the entity ID's used to make the Plane's origin.
returns ID's collected in set.
Collect all the entity ID's used to make the Plane's matrix.
returns ID's collected in set.
Collect all the entity ID's used to make the Plane.
returns ID's collected in set.
get the Plane's color.
returns the Plane's color.
get the Plane's work offset value.
returns the Plane's work offset value.
get a description of the Plane into a CStringArray.
A reference to a MastercamPlanes object to get the view #'s from.
# of places behind the decimal point.
CStringArray to stuff description into.
return size of strArray.
Returns the view # of the plane's matrix.
A reference to a MastercamPlanes object to get the view #'s from.
The view number.
get a description of the Plane.
A reference to a MastercamPlanes object to get the view #'s from.
return Plane description.
get a description of the Plane.
A reference to a MastercamPlanes object to get the view #'s from.
machine type (MILL_MACHINE, LATHE_MACHINE, etc)
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or
PlaneType::WCSPLANE)
(Optional) type of origin description (-1=origin in view coords, 0=no origin,
1=origin in world coords)
return Plane description.
get a description of the given Plane type.
the plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE, PlaneType::WCSPLANE)
return Plane type description.
get a description of the Plane type.
return Plane type description.
Convert an int to a PlaneType.
int type of the plane.
PlaneType.
Convert PlaneType to an int for use as an array index.
Type of the plane.
int.
collect the 4 Plane types.
The 4 types in CPLANE, TPLANE, GPLANE and WCS order.
return selected flag.
return selected flag.
get both the origin geometry and the geometry entities used to create the Plane.
array to copy the origin geometry into.
array to copy the geometry into.
entity ID-eptr map to look thru and find and extract entity from db with.
ID's entities that could not be found in geomMap.
returns true if any geometry was collected.
get the geometry entities used to create the Plane.
array to copy the geometry into.
entity ID-eptr map to look thru and find and extract entity from db with.
ID's entities that could not be found in geomMap.
returns # of entities copied into the array.
get the Plane's point' origin geometry entity.
array to copy the geometry into.
entity ID-eptr map to look thru and find and extract entity from db with.
ID's entities that could not be found in geomMap.
returns true if entity successfully retrieved form db.
get the Plane's points and selected entity info used in it's definition.
(Optional) True to include all 3 m_MatrixPoints[3], false for
only one associated to geometry.
Plane's points and selected entity info used in it's definition.
read thru the current db and return a P_ID entity that matches the given origin.
origin in world coordinates.
The point ent.
return geometry entity ID if successful.
return the Plane's origin in the Plane's view coordinates.
p_3d type to copy origin into.
return true if successful.
return the Plane's origin in the Plane's view coordinates.
The origin view coordinates.
Get the Plane's origin in world coordinates.
p_3d type to copy origin into.
return true if successful.
return the Plane's origin in world coordinates.
The origin world coordinates.
Gets the value in m_Transform.
the value in m_Transform.
get the Plane's origin.
returns the Plane's origin.
return Plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
return Plane type.
return the Plane's relative-to-a-WCS-Plane-ID.
return the Plane's relative-to-a-WCS-Plane-ID.
Gets creation method description.
The creation method description.
return the creation method.
returns the creation method.
Gets the value of m_SectionView.
The value of m_SectionView.
Query if 'thePlane' is equal.
the plane to compare to this.
The string to fill in with the name of the non-matching member variable.
true if equal, false if not.
compare this to another plane.
The object.
true if the first parameter is less than the second.
compare this to an group_view structure.
The object.
true if the parameters are considered equivalent.
compare this to an op_view structure.
The object.
true if the parameters are not considered equivalent.
compare this to a Matrix33 object.
The object.
true if the parameters are considered equivalent.
compare this to an group_view structure.
The object.
true if the parameters are considered equivalent.
compare this to an op_view structure.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
subtraction-assignment operator.
The third m 3.
The result of the operation.
subtraction-assignment operator.
The object.
The result of the operation.
addition-assignment operator.
The third m 3.
The result of the operation.
addition-assignment operator.
The object.
The result of the operation.
Assignment operator.
The plane base raw pointer.
A shallow copy of this object.
Assignment operator.
The plane base shared pointer.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
copy constructor.
The object.
destructor.
zero out all member variables that determine if a Plane is 'reserved'.
zero out all member variables.
Constructor.
The plane.
Constructor.
The plane.
parameteritized constructor for a normal.
the normal.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure.
parameteritized constructor for a normal.
the normal.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure.
if true, the matrix of the new plane is set based on the normal)
parameteritized constructor for an entity array. It figures out the appropriate constructor to
call based on the number of entities it contains.
A reference to a MastercamPlanes object to get the view #'s from.
array of entities.
location from original selection.
line endpoint t value.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure.
if true, the matrix of the new plane is set based on the reference entities)
parameteritized constructor for a single entity types that contain their own matrix or normal info (like arcs)
A reference to a MastercamPlanes object to get the view #'s from.
single entity (arc, spine, nurb, surface, cross-hatch, etc.
location from original selection.
line endpoint t value.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure.
if true, the matrix of the new plane is set based on the reference entity)
parameteritized constructor for 3 point entities.
A reference to a MastercamPlanes object to get the view #'s from.
point entity lying on the X axis.
point entity lying on the Y axis.
point entity defining Z axis and origin.
line endpoint t value.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or
PlaneType::WCSPLANE)
will be set to 1 for successful intersection, 2 for successful endpoint, or 0 for
failure.
parameteritized constructor for 2 line entities.
A reference to a MastercamPlanes object to get the view #'s from.
line entity defining X axis.
line entity defining Y axis.
line endpoint t value.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or
PlaneType::WCSPLANE)
will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure.
parameteritized constructor.
Mastercam op_view type.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
parameteritized constructor.
Mastercam group_view type.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
Constructor.
Mastercam view entity.
parameteritized constructor.
3x3 matrix.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
parameteritized constructor.
3x3 matrix.
Plane origin in world coordinates.
plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE)
Default constructor.
serialize this.
the destination/source archive object.
Validates this object, zero-out if not.
True if it succeeds, false if it fails.
Query if this object is valid.
True if valid, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Constructor.
Identifier for the parent plane.
Type of the relative (RelativeType::Off, RelativeType::Front, etc.)
Constructor.
Type of the relative.
Class containing plane dependency to another plane info.
Constructor method (saved in m_ConstructorMethod).
used when searching for matching planes.
comparison values to determine whether a regeneration of the plane is required.
Values that represent whether the origin and/or matrix is associated to geometry.
Plane icon drawing modes.
relative plane types.
Plane creation methods.
Sets the value of m_QuickCplaneID.
Identifier for the plane.
Previous value of m_QuickCplaneID.
Gets the value of m_QuickCplaneID.
the value of m_QuickCplaneID.
Gets status bar plane label from m_StatusBarPlaneLabels using an int.
Type of plane in int form.
The status bar plane label.
Gets status bar plane label from m_StatusBarPlaneLabels.
Type of plane.
The status bar plane label.
Query if 'coordinateDisplay' is lathe coordinate display.
The coordinate display.
true if lathe coordinate display, false if not.
Gets viewport information.
The viewport information.
Sets viewport information.
Information describing the vp.
Returns previous value
Gets the lock status for the given plane
CPLANE, TPLANE, WCS or GPLANE.
The lock.
Sets a lock on the given plane
CPLANE, TPLANE, WCS or GPLANE.
LOCK_ALL_OFF, LOCK_ORIGIN or LOCK_MATRIX.
return previous value.
Gets the previous matrix/origin pair.
CPLANE, TPLANE, WCS or GPLANE.
The previous matrix/origin pair.
Set m_Previous[] matrix/origin pairs.
CPLANE, TPLANE, WCS or GPLANE.
The matrix to set.
The origin in world coordinates.
return previous value.
Gets plane identifier.
CPLANE, TPLANE, GPLANE or WCSPLANE
The plane ID for the requested active plane.
Set m_PlaneIDs[].
The which plane.
plane ID to set.
The view no of the plane's matrix to set in m_CacheViewNos.
return previous value.
return m_UnnamedOrigin.
const reference to m_UnnamedOrigin.
Set m_UnnamedOrigin.
origin to set.
return previous value.
return a Matrix33.
Copy of m_UnnamedM33.
Set m_UnnamedM33.
matrix to set.
return previous value.
Values that represent PLANE_LOCK.
Initialises the status bar plane labels in m_StatusBarPlaneLabels.
size of m_StatusBarPlaneLabels.
Zero out member variables.
(Optional) Initialize 4 system planes to this valid ID, or -1 to preserve the follow-rules.
assignment operator.
The object.
A shallow copy of this object.
serialize this.
the destination/source archive object.
copy constructor.
The object to copy.
destructor.
Default constructor.
SystemPlanes class contains current system construction, tool, WCS and graphics planes
Sets current graphics view information.
true if it succeeds, false if it fails.
Destructor.
Default constructor.
Defines an alias representing the plane base class pointer.
Information about the active viewport.
Convert an MBCS string to a wide string.
The archive.
If non-null, the wide character buffer.
The number of characters converted.
Correct imperfect matrix in m_33.
first = matrix is valid, second = values were adjusted to make valid.
set the Plane's 3x3 matrix (m_33)
the Plane's new 3x3 matrix.
returns true if successful.
Validate plane class.
The plane class.
true for warning.
true if valid, false if not.
Return value of m_Temporary.
true if it succeeds, false if it fails.
Set m_Temporary.
if true, temporary plane will not be listed in Planes Manager and will be deleted on file/save.
return previous value.
Builds and returns system matrix name.
The identifier.
The system matrix name.
Enforce naming rules for this Plane's name.
The name to check and alter.
return true if name has been altered.
set the Plane's name.
the Plane's name.
returns true if successful.
set Plane lock's state.
true to lock, false to unlock.
Previous value.
set Plane as reserved (uneditable and unmovable)
true = reserved.
returns previous value.
return Plane lock's state.
return Plane lock's state.
Sets the tolerance for the plane.
the new tolerance.
The old tolerance.
return Plane tolerance value.
The tolerance.
get the Plane's name.
returns the Plane's name.
return true if the the Plane is a reserved Plane.
return true if the the Plane is a reserved Plane.
get the Plane's 3x3 matrix (m_33)
3x3 matrix to fill in.
get the Plane's 3x3 matrix (m_33)
returns the Plane's 3x3 matrix.
get the Plane's 3x3 matrix (m_33) reference
returns the Plane's 3x3 matrix.
set the unique ID of the plane.
Identifier for the plane.
returns the previous value.
get the value of m_ID's m_ID.
returns the value of m_ID's m_ID.
get the value of m_ID's m_ID.
returns the value of m_ID's m_ID.
get the unique ID of the plane.
returns the plane ID.
Sets value of m_GUID.
New value.
Previous value.
Return value of m_GUID.
Return value of m_GUID.
set the version.
The version.
return the previous version value.
return the version.
return the version.
Query if 'obj' is equal.
The object.
The string to fill in with the name of the non-matching member variable.
true if equal, false if not.
Return reference to X, Y or Z component of m_33.
The X, Y or Z axis (0, 1 or 2).
const reference to X, Y or Z axis.
compare this to another plane.
The object.
true if the first parameter is less than the second.
compare this to a Matrix33 object.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are considered equivalent.
compare this to an op_view structure.
The object.
true if the parameters are not considered equivalent.
compare this to an op_view structure.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
Sets the class.
The plane class.
Previous value.
Gets the class.
The class.
serialize this.
the destination/source archive object.
destructor.
Copy constructor.
The object.
parameteritized constructor.
3x3 matrix.
Identifier for the plane.
The name.
parameteritized constructor.
3x3 matrix.
Default constructor.
A macro that defines plane base version.
Mastercam PlaneBase definition
Multiply a 4D vector by a 4x3 matrix.
4D Vector.
4x3 Matrix.
Resulting 3D vector.
Multiply a 4x3 matrix by a 4D vector.
4x3 Matrix.
4D Vector.
Resulting 3D vector.
Multiply (and assign) a 3x3 matrix by another.
Matrix 1.
Matrix 2.
Reference to mat1.
Multiply two 3x3 matrices.
Matrix 1.
Matrix 2.
Resulting matrix.
Multiply (and assign) a 3D vector by a 3x3 matrix.
Matrix.
Vector.
Reference to vec.
Multiply a 3D vector by a 3x3 matrix.
Matrix.
Vector.
Resulting vector.
Multiply a 3D vector by a 3x3 matrix.
Matrix.
Vector.
Resulting vector.
Gets the description.
The description.
Query if this object is valid.
true to warn.
true if valid, false if not.
Sets an identifier.
Identifier for the.
.
Gets the identifier.
The identifier.
Gets the identifier.
The identifier.
Sets the class type.
the class.
previous value.
Gets the class type.
The class type.
Sets the GUID identifier.
Unique identifier.
Previous value.
Gets the GUID identifier.
The identifier.
Gets the version.
The version.
Inequality operator.
The object.
true if the parameters are not considered equivalent.
Equality operator.
The object.
true if the parameters are considered equivalent.
Greater-than comparison operator.
The object.
true if the first parameter is less than the second.
Less-than comparison operator.
The object.
true if the first parameter is less than the second.
Assignment operator for a long. Will create a NamedPlane type ID.
Identifier for the plane.
A shallow copy of this object.
Assignment operator.
The object.
A shallow copy of this object.
serialize this.
the destination/source archive object.
Destructor.
Constructor.
A view entity.
Constructor.
A group view.
Constructor.
An operation view.
Identifier for the plane.
(Optional) The plane class.
Constructor.
The view no.
Constructor.
Identifier for the plane.
the plane class type.
Copy constructor.
The object.
Default constructor.
(Optional) the plane class.
A macro that defines a null plane ID.
The plane identifier ( plane class undefined)
Plane ID map key.
Assignment operator.
The view no.
A shallow copy of this object.
Greater-than-or-equal comparison operator.
The view no.
true if the first parameter is less than or equal to the second.
Greater-than comparison operator.
The view no.
true if the first parameter is greater than to the second.
Less-than-or-equal comparison operator.
The view no.
true if the first parameter is less than or equal to the second.
Less-than comparison operator.
The view no.
true if the first parameter is less than the second.
Inequality operator.
The object.
true if the parameters are not considered equivalent.
Equality operator.
The view no.
true if the parameters are considered equivalent.
Destructor.
Copy constructor.
The object.
Constructor.
The view no.
Constructor.
The view no.
Constructor.
Query if this object is valid.
true if valid, false if not.
Query if this object is viewport view.
true if scratch view, false if not.
Query if this object is scratch view.
true if scratch view, false if not.
Query if 'viewType' is scratch view type.
Type of the view.
True if scratch view type, false if not.
Gets short view no.
The short view no.
Gets view no.
The view no.
Greater-than-or-equal comparison operator.
The view no.
true if the first parameter is less than or equal to the second.
Greater-than comparison operator.
The view no.
true if the first parameter is greater than to the second.
Less-than-or-equal comparison operator.
The view no.
true if the first parameter is less than or equal to the second.
Less-than comparison operator.
The view no.
true if the first parameter is less than the second.
Inequality operator.
The object.
true if the parameters are not considered equivalent.
Inequality operator.
The view no.
true if the parameters are not considered equivalent.
Equality operator.
The view no.
true if the parameters are considered equivalent.
Equality operator.
The view no.
true if the parameters are considered equivalent.
Assignment operator.
The view no.
A shallow copy of this object.
Destructor.
Copy constructor.
The object.
Constructor.
The view no.
Constructor.
The view no.
Constructor.
The view no.
Constructor.
The view no.
Constructor.
Class to be used as view number parameter instead of a short.
Values that represent the 'scratch view' types.
Tokenize the NCI strings.
The delimiter.
The first string.
The second string.
The first array.
The second array.
An INT_PTR.
Makes both NCI strings the same length.
The first NCI string.
The second NCI string.
Mark start of the NCI lines.
The first NCI string.
The first indx.
The second NCI string.
The second indx.
true if it succeeds, false if it fails.
Mark the differences in the NCI lines as compared to one another.
The first NCI string.
The second NCI string.
An number of differences marked.
Format the NCI line.
The binary NCI line.
The string to format.
Compares NCI of the 3 states to the given nci accuracy.
The comparison parameters.
Destructor.
Default constructor.
Constructor.
(Optional) the nci accuracy.
(Optional) If non-null, list of strings for the report trailer.
Comparison parameters.
Utility class to compare NCI of previous version files in 3 states:
1 - from disk before file is read in
2 - from disk immediately after file is read in
3 - after regeneration
Reports on operation's matrix/origin values.
the operation.
Dump the contents of a CStringArray to a file and display in the default editor.
The array to dump.
True to add time of day string on first line.
[in,out] Filename of the file.
true to edit file.
Empties s_spIInterrogateMastercamFile.
Loads s_spIInterrogateMastercamFile.
Returns s_spIInterrogateMastercamFile.
Gets a copy of the entity with the given ent.ent_idn value from m_spEntityMap.
Entity type info of the entity to retrieve.
the ent.
true if the entity was found and copied into theEnt.
Return true if all the operations that exist in our current database are loaded.
true if all the operations that exist in our current database are loaded.
Removes the contents of m_OpGroup, m_OtherGroups and m_GroupGeometry.
Copies the groups from an external file into m_OpGroups and m_OtherGroups.
Filename of the external Mastercam file.
Copies the groups from our current db into m_OpGroups and m_OtherGroups.
Adds the contents of the given group list to m_OpGroup and m_OtherGroups.
List of groups.
Setter for the start of bnci fpos of the source file
The bnci fpos for the source file
Getter for the start of bnci fpos of the source file
Returns long.
Preset masks and loads this object with plane info from an external Mastercam file.
Mastercam file name.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
for planes.
Preset masks and loads this object with plane info from the current db.
Number of planes loaded.
Preset masks and loads this object with operations and their NCI from an external Mastercam file.
Filename of the Mastercam file.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
true if it succeeds, false if it fails.
Preset masks and loads this object with operations and their NCI from the current db.
true if it succeeds, false if it fails.
Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs
parameter and their toolpath entities from an external Mastercam file.
Filename of the Mastercam file.
The IDs of operations to load.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
true if it succeeds, false if it fails.
Preset masks and loads this object with just the operations whose IDs match ones in
the given opIDs parameter and their toolpath entities from the current db.
The IDs of operations to load.
Operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
true if it succeeds, false if it fails.
Preset masks and loads this object with just operations and toolpath entities
from the current db.
true if it succeeds, false if it fails.
Preset masks and loads this object with just operations and TP_OPID type toolpath entities from an
external Mastercam file. TP_OPID type toolpath entities are typically used in transform and nesting
operations.
Mastercam file name.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
for dependencies.
Preset masks and loads this object with just operations and TP_OPID type toolpath entities
from the current db. TP_OPID type toolpath entities are typically used in transform
and nesting operations.
true if it succeeds, false if it fails.
Preset masks and loads this object with just the operations from the current db.
Filename of the Mastercam file.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
The number of operations loaded.
Preset masks and loads this object with just the operations from the current db.
The number of operations loaded.
Loads this object using the current db.
true if it succeeds, false if it fails.
Loads this object using the given mcx file name.
Filename of the Mastercam file.
Operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
The IDs of the operations to load, empty = all.
Collect only these types of toolpath entities, empty = all.
(Optional) What are we loading for?
true if it succeeds, false if it fails.
Tests operation code against masks before loading NCI into an operation.
The operation code.
true if the test passes, false if the test fails.
Tests operation code against masks before loading into m_Operations.
The operation code.
true if the test passes, false if the test fails.
Tests tp_net against masks before loading into m_Operations.m_TpEnts.
The entity info.
true if the test passes, false if the test fails.
Tests operation against masks before loading into m_Operations.
The entity info.
true if the test passes, false if the test fails.
Tests tool against masks before loading into m_Tools.
The entity.
true if the test passes, false if the test fails.
Tests view_ent against masks before loading into m_pPlanes.
The entity.
true if the test passes, false if the test fails.
Tests planes against masks before loading into m_pPlanes.
The entity.
true if the test passes, false if the test fails.
Tests geometry against masks before loading into m_Geometry.
The entity info.
true if the test passes, false if the test fails.
Validate operation iterator from m_Operations (since m_Operations is public).
The iterator.
true if valid, false if not.
Initializes the bnci extents.
Return true if dependent operation types exist in m_Operaitons.
Return true if dependent operation types exist in m_Operaitons.
Builds a vector of all the eptrs in this.
A shared ptr to a vector of eptrs in this.
Sets m_Masks.
The masks to set.
Gets entity map.
The entity map.
Gets the planes.
The planes.
Setter for rectangle center
p-3d point
Getter for rectangle center
Returns p_3d
Setter for rectangle's upper right corner
p-3d point
Getter for rectangle's upper right corner
Returns p_3d
Setter for rectangle's lower left corner
p-3d point
Getter for rectangle's lower left corner
Returns p_3d
Gets a refrence to m_Masks.
Reference to m_Masks.
Gets bad TP geometry reference ids.
The bad TP geometry reference ids.
Getter for array of toolpath entities that have no parent operation
Returns CFposEntArray reference
Getter for array of geometry entity copies referenced by operations from the source file
Returns CFposEntArray reference
Getter for Map of operation copies from the source file
Returns OpMap
Gets Op groups.
The Op groups.
Gets const reference to m_LoadCode.
const reference to m_LoadCode.
Swap the entity ptrs.
The map geometry entity ID, pair of old eptr and new eptr.
true to rewrite the entities to the current database.
true to mark affected toolpath operations dirty.
Number of substitutions that occurred.
Removes the operation described by opID from the map m_Operations.
Identifier for the operation.
true if it succeeds, false if it fails.
Adds (and replaces if needed) an operation to the map m_Operations.
true if entity is from an external file, false for the current db.
The operation entity.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
An OpMap::iterator where the operation was added.
Returns a vector of all the operations' IDs in order of the global Operation Manager.
A vector of all the dependent operations' IDs.
Gets the file name of what's loaded.
The file name.
Sets the contents of m_MaskNciOpcodes to filter which operation's NCI is loaded when calling load functions.
The TP_OPCODE mask.
Size of m_MaskNciOpcodes array after setting.
Sets the contents of m_MaskOpcodes to filter which operations are loaded when calling load functions.
The TP_OPCODE mask.
Size of m_MaskOpcodes array after setting.
Gets geometry entity pointer.
Identifier for the ent.
The geometry entity pointer.
Gets operation pointer by identifier.
Identifier for the operation.
null if it fails, else the operation pointer by identifier.
Gets library operation pointer by identifier.
Identifier for the operation.
null if it fails, else the library operation pointer by identifier.
Returns a vector of toolpath entities stored under the operation.
Identifier for the operation.
The operation ent to fill in.
Collect only these types of toolpath entities, empty = all.
The toolpath entities.
Query if this object was loaded from an external file.
true if external file, false if not.
Query if this object is loaded (returns value of m_Loaded).
true if loaded, false if not.
Calculates the extents of the bnci in this object.
(Optional) true to relative wcs.
(Optional) true to adjust to TOS.
(Optional) true to delete the tool radius from "Z".
(Optional) true to include the end of rapids in extents calc.
true if it succeeds, false if it fails.
Preset masks and loads this object with operations and their NCI from and external Mastercam file.
Filename of the external Mastercam file.
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
(Optional) the include operation ids.
(Optional) the exclude operation ids.
true if it succeeds, false if it fails.
Preset masks and loads this object with operations and their NCI from the current db from just the
operations whose IDs match ones in the given pIncludeOpIDs parameter and not ones whose ID's match
ones in the given pExcludeOpIDs parameter.
true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes ().
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
(Optional) the include operation ids.
(Optional) the exclude operation ids.
true if it succeeds, false if it fails.
Preset masks and loads this object with work offset information from just the operations whose IDs match
ones in the given includeOpIDs parameter and not ones whose ID's match ones in the given excludeOpIDs
parameter.
true = use NCI cache, false = read from disk.
The operations to include.
The operations to exclude.
true if it succeeds, false if it fails.
Preset masks and loads this object for just the 1 operation from the current db.
Identifier for the operation.
true to include NCI, false to exclude NCI.
(Optional) if (includeNci == true), ptr to NCI gcode mask, nullptr to read in all.
pointer to operation, null if it fails.
Initializes the masks.
Transfers the contents described by spInFile.
ptr to snapshot of current Mastercam file.
Empties this object.
Destructor.
Default constructor.
Utility class to collect entities and info of the current db or an external Mastercam file.
Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs
parameter and their toolpath entities from an external Mastercam file.
ptr to snapshot of current Mastercam file.
Filename of the Mastercam file.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
The IDs of operations to load.
Collect only these types of toolpath entities, empty = all.
true if it succeeds, false if it fails.
Loads an interrogate.
ptr to snapshot of current Mastercam file.
The operation ids.
The TP mask.
(Optional) The load code.
True if it succeeds, false if it fails.
Loads an interrogate.
ptr to snapshot of current Mastercam file.
Filename of the mcx file.
The ent allocation.
(Optional) The load code.
True if it succeeds, false if it fails.
Loads interrogate file.
ptr to snapshot of current Mastercam file.
(Optional) The load code.
True if it succeeds, false if it fails.
Builds and loads an IInterrogateMastercamFile class containing info from your current file.
Entity masks.
A std::shared_ptr<IInterrogateMastercamFile>
Builds and loads an IInterrogateMastercamFile class containing info from your current file.
(Optional) The load code (to preset m_Masks).
A std::shared_ptr<IInterrogateMastercamFile>
Loads.
ptr to snapshot of current Mastercam file.
The operation i ds.
The TP mask.
(Optional) The load code.
A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>>
Loads.
ptr to snapshot of current Mastercam file.
The operation i ds.
The TP mask.
(Optional) The load code.
A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>>
Loads.
ptr to snapshot of current Mastercam file.
Filename of the mcx file.
The ent allocation.
(Optional) The load code.
A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>>
Loads the given load code.
ptr to snapshot of current Mastercam file.
(Optional) The load code to load.
A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>>
Builds and loads an IInterrogateMastercamFile class containing info from your current file.
Entity masks.
A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>>
Builds and loads an IInterrogateMastercamFile class containing info from your current file.
Entity masks.
A std::shared_ptr<IInterrogateMastercamFile>
Default constructor.
Destructor.
Builds and loads an IInterrogateMastercamFile class containing info from your current file.
The load code (preset m_Masks).
A std::shared_ptr<IInterrogateMastercamFile>
Creates collection of entities and info of current db or external Mastercam files.
Constructor.
pointer to an eptr in the entity.
ent.ent_idn of entity that eptr resides in.
ent.ent_idn of entity that m_pEptr points to.
Entity information for MapEptrs
Gets entity map.
The entity map.
Gets the planes.
The planes.
Setter for rectangle center
p-3d point
Getter for rectangle center
Returns p_3d
Setter for rectangle's upper right corner
p-3d point
Getter for rectangle's upper right corner
Returns p_3d
Setter for rectangle's lower left corner
p-3d point
Getter for rectangle's lower left corner
Returns p_3d
Gets a const reference to m_Masks.
const reference to m_Masks.
include/exclude masks for loading.
Gets bad TP geometry reference ids.
The bad TP geometry reference ids.
Getter for array of entities without references from the source file
Returns CFposEntArray reference
Getter for array of geometry entity copies referenced by operations from the source file
Returns CFposEntArray reference
Getter for Map of operation copies from the source file
Returns OpMap
Gets Op groups.
The Op groups.
Gets const reference to m_LoadCode.
const reference to m_LoadCode.
Swap the entity ptrs.
The map geometry entity ID, pair of old eptr and new eptr.
true to rewrite the entities to the current database.
true to mark affected toolpath operations dirty.
Number of substitutions that occurred.
Removes the operation described by opID from the map m_Operations.
Identifier for the operation.
true if it succeeds, false if it fails.
Adds (and replaces if needed) an operation to the map m_Operations.
true if entity is from an external file, false for the current db.
The operation entity.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
An OpMap::iterator where the operation was added.
Defines an alias representing the operation map pointer.
Defines an alias representing the operation map (operation ID, copy of operation).
Returns a vector of all the operations' IDs in order of the global Operation Manager.
A vector of all the dependent operations' IDs.
Gets the file name of what's loaded.
The file name.
Sets the contents of m_MaskNciOpcodes to filter which operation's NCI is loaded when calling load functions.
The TP_OPCODE mask.
Size of m_MaskNciOpcodes array after setting.
Sets the contents of m_MaskOpcodes to filter which operations are loaded when calling load functions.
The TP_OPCODE mask.
Size of m_MaskOpcodes array after setting.
Gets geometry entity pointer.
Identifier for the ent.
The geometry entity pointer.
Gets operation pointer by identifier.
Identifier for the operation.
null if it fails, else the operation pointer by identifier.
Gets library operation pointer by identifier.
Identifier for the operation.
null if it fails, else the library operation pointer by identifier.
Returns a vector of toolpath entities stored under the operation.
Identifier for the operation.
The operation ent to fill in.
Collect only these types of toolpath entities, empty = all.
The toolpath entities.
Query if this object was loaded from an external file.
true if external file, false if not.
Query if this object is loaded (returns value of m_Loaded).
true if loaded, false if not.
Calculates the extents of the bnci in this object.
(Optional) true to relative wcs.
(Optional) true to adjust to TOS.
(Optional) true to delete the tool radius from "Z".
(Optional) true to include the end of rapids in extents calc.
true if it succeeds, false if it fails.
Preset masks and loads this object with operations and their NCI from and external Mastercam file.
Filename of the external Mastercam file.
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
(Optional) the include operation ids.
(Optional) the exclude operation ids.
true if it succeeds, false if it fails.
Preset masks and loads this object with operations and their NCI from the current db from just the
operations whose IDs match ones in the given pIncludeOpIDs parameter and not ones whose ID's match
ones in the given pExcludeOpIDs parameter.
true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes ().
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
(Optional) the include operation ids.
(Optional) the exclude operation ids.
true if it succeeds, false if it fails.
Preset masks and loads this object with work offset information from just the operations whose IDs match
ones in the given includeOpIDs parameter and not ones whose ID's match ones in the given excludeOpIDs
parameter.
true = use NCI cache, false = read from disk.
The operations to include.
The operations to exclude.
true if it succeeds, false if it fails.
Preset masks and loads this object for just the 1 operation from the current db.
Identifier for the operation.
true to include NCI, false to exclude NCI.
(Optional) if (includeNci == true), ptr to NCI gcode mask, nullptr to read in all.
pointer to operation, null if it fails.
Loads this object using the given mcx file name.
Filename of the Mastercam file.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
The IDs of the operations to load, empty = all.
Collect only these types of toolpath entities, empty = all.
(Optional) What are we loading for?
true if it succeeds, false if it fails.
Initializes the masks.
Transfers the contents described by spInFile.
ptr to snapshot of current Mastercam file.
Empties this object.
Destructor.
Utility class to collect entities and info of the current db or an external Mastercam file.
Initializes the bnci extents.
Reads the operation's nci section from fposStartOfSection thru fposEndOfSection into m_spBnciRW.
[in,out] If non-null, the open file.
The file position to start reading.
The file end position of the last line to read.
The gcode mask.
The number of lines read into m_spBnciRW.
Reads the operation's nci section into m_spBnciRW.
true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes ().
(Optional) The gcode mask.
The number of lines read into m_spBnciRW.
Calculates the bnci extents.
(Optional) true to relative wcs.
(Optional) true to adjust to TOS.
(Optional) true to delete the tool radius from "Z".
(Optional) true to include the end of rapids in extents calc.
true if successful.
Free the operation's varaible length data.
Empties this object.
Gets a ptr to the operation.
null if it fails, else the operation pointer.
Destructor.
Constructor.
true if entity is from an external file, false for the current db.
The operation entity.
operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep)
Copy constructor.
The object.
Default constructor.
Values that represent how to load operations' variable length data
when interrogating external Mastercam files.
A toolpath operation's entity, associated toolpath entities and NCI information.
Sets value of m_UseMultiMap.
true = allow duplicate keys in m_Map, false = ensure unique keys (like std::map).
Previous value of m_UseMultiMap.
Adds theEntity to m_Map.
The map key.
true if entity is from an external file, false for the current db.
the entity.
A MapType::iterator to the item added.
Assignment operator.
Source for the object.
A shallow copy of this object.
Copy constructor.
The object.
Destructor.
Defines an alias representing type of the map.
Default constructor.
Array of entity information.
Defines an alias representing type of the byte.
Copies the critical depths from m_CriticalDepths to theEnt.
the entity to copy to.
true to just zero out the ent.
true if it succeeds, false if it fails.
Allocate memory to house the entity.
The entity size.
nullptr if it fails, else an ent*.
Initializes this object.
Gets const reference to m_FormulaeFile.
const reference to m_FormulaeFile.
Gets const reference to m_CriticalDepths.
const reference to m_CriticalDepths.
Gets a copy of the ent defined in m_spBlock.
the entity to fill in.
(Optional) true to copy variable length parameters (critical depths,
formulae file, etc.).
Size of entity if successful, 0 or -1 on failure.
Returns an ent* to m_spBlock.
Returns an ent* to m_spBlock.
Gets the size of theEnt.
the entity.
The ent size.
Gets the entity stored in m_spBlock from the current database.
The entity to fill in.
Size of entity if successful, 0 or -1 on failure.
Replaces the given entity in m_spBlock.
The entity.
Size of entity if successful, 0 or -1 on failure.
Allocate memory and copy entity in member variable.
true if entity is from an external file, false for the current db.
The entity to attach.
Size of entity if successful, 0 or -1 on failure.
Destructor.
Default constructor.
Entity information.
Ensure the group name is unique.
[in,out] the group name.
Return true if name altered.
Gets pointer to the group by its ID.
Identifier for the group.
Null if it fails, else the pointer by identifier.
Gets the next unique identifier.
The next unique identifier.
Resets the invalid parent group identifiers in groups.
Clears the select bits in groups' entities or all entities in the db.
The IDs of the groups that contain the entities to clear the select bits from.
Empty = clear the SELECT_BIT from all entities in the db.
True to redraw the entities.
Visits the stored identifiers of associated entities and updates them via the supplied visitor.
The visitor that will update the stored identifiers of associated entities.
Visits the identifiers of the entities that this entity is associated to.
The visitor that will accept the identifiers of the associated entities.
Removes any IDs of entities that no longer exist in the db from the groups.
List of IDs for groups to check, empty to check all groups.
Number of entity IDs removed.
Appends another GroupListEntity to this.
The GroupListEntity that contains the groups we want to append.
A map of source group ID's and the actual group IDs they were assigned if any
conflicts with existing groups were found.
Makes entity map using all the entity ids (ent.ent_idn) from all the group in this.
Identifiers for the groups that contain the entities you want to make
a map of.
True to save a copy of the entity in the EntityMap.
A std::shared_ptr<EntityMap>
Remove ALL entity ID's from our groups with the given IDs.
List of group IDs to remove from.
Gets a map of group IDs and the entities that belong to them from the given entIds.
List of identifiers (ent.ent_idn) for the entities.
Map of group IDs and the entities that belong to them from the given entIds.
Build and return a list of entity eptrs (ent.eptr) from the current db referenced by
the groups.
List of identifiers for the groups.
List of entity eptrs (ent.eptr) from the current db referenced by the groups.
Build and return a list of entities from the current db referenced by the groups.
List of identifiers for the groups.
The entities.
Sets the ent.sel value on entities from groups in the current db.
The IDs of the groups to collect entities from.
Select bits to clean in ent.sel (except ALIVE_BIT).
Select bits to set in ent.sel (except ALIVE_BIT).
True to also draw the entities.
A list of eptrs of the entities in these groups that changed.
Adds a group to the underlying container.
[in,out] The group to add.
const pointer to the newly added group, nullptr if failed.
Adds a group to the underlying container.
[in,out] The group to add.
const pointer to the newly added group, nullptr if failed.
Gets group list type.
The group list type.
Gets all the child group identifiers of the group with the given ID.
Identifier for the parent group.
The child group identifiers.
Gets all the parent group identifiers of the group with the given ID.
Identifier for the group.
The parent group identifiers.
Attempt to cast a BaseGroup pointer to a ToolpathGroup pointer (group type is checked).
pointer to a BaseGroup.
Null if it fails, else a pointer to a const ToolpathGroup.
Attempt to cast a BaseGroup pointer to a GeometryGroup pointer (group type is checked).
pointer to a BaseGroup.
Null if it fails, else a pointer to a const GeometryGroup.
Make a copy of any type of group and return a shared_ptr to a BaseGroupPtr.
The group to copy.
A BaseGroupPtr.
Adds the standard system GROUP and RESULT groups.
Gets a const toolpath group pointer from the underlying map.
Name of the group (not case sensitive).
Null if it fails, else the geometry group pointer.
Gets a const toolpath group pointer from the underlying map.
Identifier for the group.
Null if it fails, else the toolpath group pointer.
Queries if a given name exists.
The name to check.
Identifier for the group to exclude in the check.
True to warn of existing name.
True if name exists, otherwise false.
Gets a const geometry group pointer from the underlying map.
Name of the group (not case sensitive).
Null if it fails, else the geometry group pointer.
Gets a const geometry group pointer from the underlying map.
Identifier for the group.
Null if it fails, else the geometry group pointer.
Unhighlight the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to unhighlight.
Highlight the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to highlight.
true = first unhighlight all entities, false = append to current highlightment.
Unelect the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to unselect.
True to draw the entity.
Select the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to select.
true = first unselect all entities, false = append to current
selections.
True to draw the entity.
Swap entity identifiers in the given groups.
List of group IDs to swap entity IDs in.
old entity ID to remove.
new entity ID to replace the old one with.
set of IDs of groups updated.
Swap entity identifiers in the given groups.
List of group IDs to swap entity IDs in.
Map of old and new entity IDs to swap in groups.
set of IDs of groups updated.
Removes the entity identifiers that are NOT in the given EntityMap.
The entity map that contains valid entities.
True to delete any groups that become empty .
Total number of ent.ent_idn removed the groups.
Remove entity ID's from our groups with the given IDs.
List of group IDs to remove from.
List of identifiers for the entities (ent.ent_idn) to remove from the groups.
(Optional) True to delete the group if it's now empty.
Total number of ent.ent_idn removed the groups.
Adds entities from our db by their matching select bit (ent.sel) to the groups with
the given IDs.
List of group IDs to add to.
The select bits (SELECT_BIT, GROUP_BIT, etc).
Total number of ent.ent_idn added to the groups.
Adds entity ID's to groups with the given IDs.
List of group IDs to add to.
List of identifiers for the entities (ent.ent_idn) to add to the
groups.
Total number of ent.ent_idn added to the groups.
Gets a set of group IDs that reference the given eptrs.
List of eptrs (ent.eptr) for the entities.
Set of group IDs that reference the given eptrs.
Gets a set of group IDs that reference the given entIds.
List of identifiers (ent.ent_idn) for the entities.
Set of group IDs that reference the given entIds.
Gets the root group pointer of the group with the given ID.
Identifier for the group.
Null if it fails, else a const pointer to the root group.
Build and return a list of group IDs in this.
List of group IDs in this.
Build and return a list of entity IDs (ent.ent_idn) from the current db referenced by
the groups.
List of identifiers for the groups.
List of entity IDs (ent.ent_idn) from the current db referenced by the groups.
Returns a list of group IDs that have the same contents as other groups.
The duplicate group identifiers.
Removes extra groups that contain the same references.
IDs of groups removed.
Removes all groups that do not contain any entity IDs.
(Optional) True to check parent identifiers.
IDs of groups removed.
Removes groups with the given IDs.
IDs of the groups to remove.
(Optional) The delete option.
IDs of groups removed.
Replaces the given group.
The group.
const iterator of group in map.
Query if this object is empty.
True if empty, false if not.
Empties this object.
Gets a reference to the underlying map.
The map.
Gets a constant reference to the underlying map.
The map.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Assignment operator.
The object.
A shallow copy of this object.
Return the entity type (for ClassEnt)
Return the entity type. -
serialize this.
the destination/source archive object.
Constructor.
The object.
destructor.
Constructor setting the group type.
(Optional) Type of the group list.
GroupListEntity class.
Appends another GroupListEntity to this.
The GroupListEntity that contains the groups we want to append.
A map of source group ID's and the actual group IDs they were assigned if any
conflicts with existing groups were found.
Remove ALL entity ID's from our groups with the given IDs.
List of group IDs to remove from.
Gets a map of group IDs and the entities that belong to them from the given entIds.
List of identifiers (ent.ent_idn) for the entities.
Map of group IDs and the entities that belong to them from the given entIds.
Build and return a list of entity eptrs (ent.eptr) from the current db referenced by
the groups.
List of identifiers for the groups.
List of entity eptrs (ent.eptr) from the current db referenced by the groups.
Build and return a list of entities from the current db referenced by the groups.
List of identifiers for the groups.
The entities.
Sets the ent.sel value on entities from groups in the current db.
The IDs of the groups to collect entities from.
Select bits to clean in ent.sel (except ALIVE_BIT).
Select bits to set in ent.sel (except ALIVE_BIT).
True to also draw the entities.
A list of eptrs of the entities in these groups that changed.
Adds a group to the underlying container.
[in,out] The group to add.
const pointer to the newly added group, nullptr if failed.
Adds a group to the underlying container.
[in,out] The group to add.
const pointer to the newly added group, nullptr if failed.
Gets group list type.
The group list type.
Gets all the child group identifiers of the group with the given ID.
Identifier for the parent group.
The child group identifiers.
Gets all the parent group identifiers of the group with the given ID.
Identifier for the group.
The parent group identifiers.
Adds the standard system GROUP and RESULT groups.
Gets a const toolpath group pointer from the underlying map.
Name of the group (not case sensitive).
Null if it fails, else the geometry group pointer.
Gets a const toolpath group pointer from the underlying map.
Identifier for the group.
Null if it fails, else the toolpath group pointer.
Queries if a given name exists.
The name to check.
Identifier for the group to exclude in the check.
True to warn of existing name.
True if name exists, otherwise false.
Gets a const geometry group pointer from the underlying map.
Name of the group (not case sensitive).
Null if it fails, else the geometry group pointer.
Gets a const geometry group pointer from the underlying map.
Identifier for the group.
Null if it fails, else the geometry group pointer.
Unelect the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to unselect.
True to draw the entity.
Select the entities referenced by the groups with the given IDs in our current db.
The IDs of the groups to select.
true = first unselect all entities, false = append to current
selections.
True to draw the entity.
Swap entity identifiers in the given groups.
List of group IDs to swap entity IDs in.
old entity ID to remove.
new entity ID to replace the old one with.
set of IDs of groups updated.
Swap entity identifiers in the given groups.
List of group IDs to swap entity IDs in.
Map of old and new entity IDs to swap in groups.
set of IDs of groups updated.
Remove entity ID's from our groups with the given IDs.
List of group IDs to remove from.
List of identifiers for the entities (ent.ent_idn) to remove from the groups.
(Optional) True to delete the group if it's now empty.
Total number of ent.ent_idn removed the groups.
Adds entities from our db by their matching select bit (ent.sel) to the groups with
the given IDs.
List of group IDs to add to.
The select bits (SELECT_BIT, GROUP_BIT, etc).
Total number of ent.ent_idn added to the groups.
Adds entity ID's to groups with the given IDs.
List of group IDs to add to.
List of identifiers for the entities (ent.ent_idn) to add to the
groups.
Total number of ent.ent_idn added to the groups.
Gets a set of group IDs that reference the given eptrs.
List of eptrs (ent.eptr) for the entities.
Set of group IDs that reference the given eptrs.
Gets a set of group IDs that reference the given entIds.
List of identifiers (ent.ent_idn) for the entities.
Set of group IDs that reference the given entIds.
Gets the root group pointer of the group with the given ID.
Identifier for the group.
Null if it fails, else a const pointer to the root group.
Build and return a list of group IDs in this.
List of group IDs in this.
Build and return a list of entity IDs (ent.ent_idn) from the current db referenced by
the groups.
List of identifiers for the groups.
List of entity IDs (ent.ent_idn) from the current db referenced by the groups.
Returns a list of group IDs that have the same contents as other groups.
The duplicate group identifiers.
Removes extra groups that contain the same references.
IDs of groups removed.
Removes all groups that do not contain any entity IDs.
(Optional) True to check parent identifiers.
IDs of groups removed.
Removes groups with the given IDs.
IDs of the groups to remove.
(Optional) The delete option.
IDs of groups removed.
Values that represent delete options for the Remove() function.
Replaces the given group.
The group.
const iterator of group in map.
Query if this object is empty.
True if empty, false if not.
Empties this object.
Gets a reference to the underlying map.
The map.
Gets a constant reference to the underlying map.
The map.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Assignment operator.
The object.
A shallow copy of this object.
Return the entity type (for ClassEnt)
Return the entity type. -
Destructor.
IGroupListEntity class.
Gets the assoc_id representing the ClassEnt type (OP_ID, etc).
The assoc_id representing the ClassEnt type.
Gets the entity id representing the ClassEnt type (ASSOC_ID, N_ID, etc).
The entity id representing the ClassEnt type.
Adds a derived class.
Identifier for the ent.
Identifier for the associated.
The function.
true if it succeeds, false if it fails.
Adds/Sets the default constructor to the ClassEnt class factory.
If an unknown ClassEnt type is encountered while deserialization, this constructor will be invoked to contain the unknown typed entity.
The default constructor function.
true if it succeeds, false if it fails.
Creates the ClassEnt object instance and deserializes it from the file.
The file to read from.
The entity.
The bytes.
null if it fails, else the new from file.
Get Version (used in XML serialization).
the version
Reads/Deserializes entity from the given file.
The file to read from.
Size of the block in bytes containing the entity.
true if it succeeds, false if it fails.
Writes/Serializes entity to the given file.
The file to write to.
true if it succeeds, false if it fails.
Gets buffer size.
the buffer size is the memory footprint that the entity takes in the serialized form.
The buffer size.
Gets the ent_idn of the Mastercam entity that is represented by this instance.
The Mastercam entity ent_idn value.
Determines if we can detach from database.
true if it succeeds, false if it fails.
Detach from database.
The entity idn.
true if it succeeds, false if it fails.
Detach from supplied entity.
The entity.
true if it succeeds, false if it fails.
Attach to supplied entity.
The entity.
entity idn or -1.
Attach to entity and update database.
The entity.
entity idn or -1.
Attach to entity and store in database.
entity idn or -1.
Visits the stored identifiers of associated entities and updates them via the supplied visitor.
The visitor that will update the stored identifiers of associated entities.
Visits the identifiers of the entities that this entity is associated to.
The visitor that will accept the identifiers of the associated entities.
Visits the identifiers used for database entity association and updates them via the supplied visitor.
The visitor that will update the stored identifiers that can be used for association.
Visit the identifiers used for database entity association that this entity defines.
The visitor that will accept identifiers on this entity that can be used for association.
Finalizes an instance of the ClassEnt class.
Initializes a new instance of the ClassEnt class.
Base class providing a more object oriented approach to Mastercam entities.
Reads/Deserializes entity from the given file.
The file to read from.
Size of the block in bytes containing the entity.
true if it succeeds, false if it fails.
Writes/Serializes the entity from a given archive.
The archive to write to.
true if it succeeds, false if it fails.
Writes/Serializes entity to the given file.
The file to write to.
true if it succeeds, false if it fails.
Gets buffer size.
the buffer size is the memory footprint that the entity takes in the serialized form.
The buffer size.
Gets the ent_idn of the Mastercam entity that is represented by this instance.
The Mastercam entity ent_idn value.
Determines if we can detach from database.
true if it succeeds, false if it fails.
Detach from database.
The entity idn.
true if it succeeds, false if it fails.
Detach from supplied entity.
The entity.
true if it succeeds, false if it fails.
Attach to supplied entity.
The entity.
entity idn or -1.
Attach to entity and update database.
The entity.
entity idn or -1.
Attach to entity and store in database.
entity idn or -1.
An interface representing a class entity.
Visits the stored identifiers of associated entities and updates them via the supplied visitor.
The visitor that will update the stored identifiers of associated entities.
Visits the identifiers of the entities that this entity is associated to.
The visitor that will accept the identifiers of the associated entities.
Visits the identifiers used for database entity association and updates them via the supplied visitor.
The visitor that will update the stored identifiers that can be used for association.
Visit the identifiers used for database entity association that this entity defines.
The visitor that will accept identifiers on this entity that can be used for association.
An interface representing a class entity.
Initializes this object.
Query if this object is machine group.
True if machine group, false if not.
Query if this object is toolpath group.
True if toolpath group, false if not.
Maps this into an op_group structure.
[in,out] The target op_group to map into.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Assignment operator.
The object.
A shallow copy of this object.
Constructor.
A base group class.
Constructor.
The old style group structure.
Copy constructor.
The object.
serialize this.
the destination/source archive object.
destructor.
Constructor.
The group name.
Identifier for the parent.
True to set as hidden.
(Optional) ID of the group.
Default constructor.
@defgroup dbvars_ch4 Surface IDs
* @note used in surface header f.type 0 - 15
@{
@}
@defgroup dbvars_ch1 Sel bit constants
@{
@}
@defgroup dbvars_ch5 file types (used with FILE_ID, PMESH_ID, and STOCK_ID entities)
@{
@}
@defgroup dbvars_ch7 Entity ID masks
@{
@}
@defgroup dbvars_ch8 'task' values for file i/o
* 'task' values for file input/output (see especially dbutil.c)
@{
@}
@defgroup dbvars_ch9 product codes
@{
@}
ToolpathGroup class.
Query if origin corner is top or bottom corner.
The origin corner.
True if origin corner is Top, false if it's Bottom.
@par Purpose:
Initializes a new group to whatever parameters are passed in.
@param[in] gpl the group to be initialized
@param[in] name new group name
@param[in] parent_idn parent group id #
@param[in] hidden true = if you want group marked hidden
@param[in] type type of group
@param[in] product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, PRODUCT_WIRE, or PRODUCT_MT
@par Purpose:
add a new group (empty) to the list
@param[in] name new group name
@param[in] parent_idn parent group id #
@param[in] hidden true = if you want group marked hidden
@param[in] type type of group
@param[in] product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, PRODUCT_WIRE, or PRODUCT_MT
@param[in] move_insert_arrow move insert arrow after group in opmgr
@param[out] succf true = group added
@returns A pointer to the group newly added to the list
@}
@defgroup groups_ch3 PRODUCT_LATHE and PRODUCT_MT parameters
@{
@}
@defgroup groups_ch2 PRODUCT_MILL, PRODUCT_ROUTER, PRODUCT_WIRE parameters
@{
@defgroup groups_ch1 common parameters
@{
@note group_pg2 is meaningless without the
* product type, which is in the op_group
machine group tool settings
machine group file settings
MCExtensions lathe machine parameters
Tplane Z information for MCExtensions lathe machine parameters used with the MT Platform machines.
Turn profile parameters
entity map structure
advanced tool options structure
steady rest structure (v9)
tailstock structure (v9)
chuck jaw structure (v9)
round bar stock (with optional hole) structure
How to compute Tplane Z coordinate for MT Platform lathe MCExtensions extended data.
Values that represent MT JobSetup Work Types. (Note: LATHE_WORK_BAR / CHUCK deprecated old values).
The base group pointer.
Initializes this object.
Query if this object is geometry group.
True if geometry group, false if not.
Query if this object is system group.
True if system group, false if not.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Assignment operator.
The object.
A shallow copy of this object.
Constructor.
A base group class.
Constructor.
The old style group structure.
destructor.
serialize this.
the destination/source archive object.
Constructor.
The group name.
Identifier for the parent.
True to set as hidden.
(Optional) Requested ID to assign to the new group. Will be
reassigned if found to conflict with existing groups.
Default constructor.
The base group pointer.
GeometryGroup class.
Initializes this object.
Type of group.
Requested ID to assign to the new group. Will be reassigned
if found to conflict with existing groups.
Gets the name.
The name.
Gets the type.
The type.
Unhighlight entities.
Highlight entities from this group in the current db.
true = first unhighlight all entities, false = append to current highlightment.
Pointer to an entity map, nullptr = we'll create our own (expensive).
Unselect entities from this group in the current db.
True to draw the entity.
Pointer to an entity map, nullptr = we'll create our own (expensive).
A list of eptrs of unselected entities.
Select entities from this group in the current db.
True to first clear any currently selected entities, false to add
to selected entities.
True to draw the entity.
Pointer to an entity map, nullptr = we'll create our own (expensive).
A list of eptrs of selected entities.
Sets the ent.sel value on entities from this group in the current db.
Select bits to clean in ent.sel (except ALIVE_BIT).
Select bits to set in ent.sel (except ALIVE_BIT).
True to also draw the entity.
Pointer to an entity map, nullptr = we'll create our own (expensive).
A list of eptrs of the entities in this group that changed.
Swap entity identifiers (like we need to do when geometry transform occurs).
Map of old and new entity IDs to swap in groups.
Number of IDs swapped.
Remove entity ID's to our group.
List of identifiers for the entities (ent.ent_idn).
Number of IDs remaining in m_EntIds.
Adds entity ID's to our group.
List of identifiers for the entities (ent.ent_idn).
Number of IDs added (filters out duplicates).
Assignment operator.
The object.
A shallow copy of this object.
Maps this into an op_group structure.
[in,out] The target op_group to map into.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Constructor.
The old style group structure.
Copy constructor.
The object.
serialize this.
the destination/source archive object.
destructor.
Constructor.
Type of the group.
The group name.
Identifier for the parent group.
True to set as hidden.
(Optional) Requested ID to assign to the new group. Will be
reassigned if found to conflict with existing groups.
Constructor.
(Optional) The group name.
(Optional) Requested ID to assign to the new group. Will be
reassigned if found to conflict with existing groups.
BaseGroup class.
Read through our database, build and return a shared_ptr to an EntityMap class.
(Optional) The entity type mask (ent.ent_id like
ALL_ENTITIES_MASK, PLASNB_MASK, L_ID, etc).
(Optional) The selection bit mask (SELECT_BIT, GROUP_BIT, etc).
(Optional) Memory management method when making a copy of the entity.
A shared_ptr to an EntityMap class.
Read through an external Mastercam file, build and return a shared_ptr to an EntityMap class.
Full path of an existing Mastercam file.
The include mask function.
Load parameters.
A shared_ptr to an EntityMap class.
Read through our database, build and return a shared_ptr to an EntityMap class.
The include mask function.
(Optional) Pointer to load parameters.
A shared_ptr to an EntityMap class.
Query if this object contains an entity copy.
True if empty, false if not.
Query if this object is any kind of chain entity.
True if chain entity, false if not.
Query if this object is chain boundary.
True if chain boundary, false if not.
Query if this object is chain header.
True if chain header, false if not.
Query if this object represents a toolpath entity.
True if toolpath entity, false if not.
Query if this object represents an operation entity.
True if operation entity, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Gets a const ent pointer directly into the variable length buffer and the buffer size.
Returns a const ent* and the buffer size. The buffer size is also returned as insurance so any caller is
aware that it may not be a full-sized entity at the pointer so don't dereference the returned pointer
and do an "ent myEntity = *pEnt;".
Copies a full-sized entity from the variable-length buffer.
first = a full-sized copy of the entity, second = true if successful.
Copies a full-sized entity from the variable-length buffer.
The entity to fill in.
Return true if successful, false if not.
Default constructor.
Constructor.
ent.ent_idn value of the entity.
(Optional) ent.id value of the entity.
(Optional) ent.assoc_id value of the entity.
(Optional) ent.eptr value of the entity.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Chain specific toolpath entitiy information.
Information from the toolpath entity.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Query if 'obj' is equal.
The object.
True if equal, false if not.
Information about the operation entity.
Gets a full-sized copy of the entity.
A full-sized copy of the entity, true if successful.
Gets the entity from the variable-length buffer.
The entity to fill in.
Return true if successful, false if not.
Initializes this object with the given entity.
The entity to copy.
Query if this object is empty.
True if empty, false if not.
Assignment operator.
The object.
A shallow copy of this object.
Constructor.
The entity to copy.
Default constructor.
Container class of MC_BYTES to house the true size of the entity and not the largest.
Information about the entity.
Equality operator.
The object.
True if the parameters are considered equivalent.
Values that represent desired sort order when calling GetData().
Values that represent how to handle copying of entities and their variable length data.
Parameters to pass to MakeEntityMap().
Query if 'typeID' is lathe Tplane.
Identifier for the type.
true if lathe Tplane, false if not.
Adds a reserved name by resource ID to m_Names.
The reserved name.
The reserved type ID.
The resource ID of the reserved name.
true if it succeeds, false if it fails.
Adds a reserved name by resource ID to m_Names.
The resource ID of the reserved name.
The reserved type ID.
true if it succeeds, false if it fails.
Builds the lathe Tplane name map.
true to first clear m_Names and m_LatheNames to force reload.
size of m_LatheNames.
Builds the reserved name map.
true to first clear m_Names and m_LatheNames to force reload.
size of m_Named.
Build the array of hard-coded matrices.
Size of array m_StandardMatrices.
Query if the long 'typeID' is a valid Iso type.
Identifier for the type.
true if lathe tplane, false if not.
Warning that a special lathe tplane is set as reserved.
Identifier for the plane.
true if being set as reserved.
return true if the plane ID is a reserved lathe construction plane ID.
the Plane ID to check.
return true if the plane ID is a default one.
Return true if the ID is one of the first standard plane ID's.
the Plane ID to check.
true to include Lathe_Z_Equals_World_Z.
true if one of the first standard, false if not.
Query if 'typeID' is VTL type.
Identifier for the type.
True if a VTL type, false if not.
Query if the long 'typeID' is a valid lathe TypeID.
Identifier for the type.
true if lathe tplane, false if not.
Query if the long 'typeID' is a valid lathe Tplane TypeID.
Identifier for the type.
true if lathe tplane, false if not.
Gets lathe names.
The lathe names.
Gets the names.
The names.
Gets const reference to m_StandardMatrices.
The standard matrices.
Gets constant reference to m_LathePlaneMap.
The map.
Gets constant reference to the map.
The map.
Gets the size of m_Map.
The size.
Builds the map m_Map.
AEB_MILL, AEB_LATHE, AEB_MT or a combination of all.
true to first clear m_Names and m_LatheNames to force reload.
Size of map.
Gets a pointer to a reserved plane with the matching class and matrix.
PlaneClass::SystemMatrix or PlaneClass::NamedPlane.
Matrix to match.
null if it fails, else the pointer.
Sets a reserved plane name.
New name of the reserved plane.
Identifier for the reserved plane type.
true if it succeeds, false if it fails.
Gets a name by TypeID.
Identifier for the type.
The name.
Gets a pointer to a reserved plane with the matching name (not case sensitive).
Name to match.
null if it fails, else the pointer.
Gets a pointer to a kinda-reserved super special lathe Tplane with the matching type ID.
Identifier for the type.
null if it fails, else the pointer.
Gets a pointer to a reserved plane with the matching type ID.
Identifier for the type.
null if it fails, else the pointer.
Gets a pointer to the reserved info.
Identifier for the resource.
null if it fails, else the pointer.
Query if 'name' is reserved name.
The name.
set to true = same name, but the case is mismatched.
true if reserved name, false if not.
Casts a TypeID identifier to a long.
Identifier for the type.
true for debug warning.
A long, 0 if invalid type.
Query if 'longType' is valid TypeID.
TypeID as a long.
true for debug warning.
true if valid type, false if not.
Query if 'resType' is system matrix identifier.
Identifier for the resource.
true if system matrix identifier, false if not.
Return copy of hard-coded matrices if within range.
Array index in m_StandardMatrices.
The standard matrix.
Assignment operator.
The object.
A shallow copy of this object.
Defines an alias representing the reserved plane map.
Defines an alias representing the reserved plane pair.
Defines an alias representing list of names of the reserved planes.
Defines an alias representing the reserved name pair.
Defines an alias representing list of names of the lathe tplanes.
Copy constructor.
The object.
Constructor.
Identifier for the type.
The name.
(Optional) identifier for the resource ID.
Information about the name.
Named view constructor.
Identifier for the resource.
The matrix.
The product.
The coordinate display.
true to place holder.
SystemMatrix constructor.
Identifier for the resource.
The matrix.
Default constructor.
Information about the reserved plane.
Reserved ID's for standard planes that are non-editable.
Destructor.
Default constructor.
A to create and maintain the reserved planes.
Sets the color of the plane.
Plane color.
Return true if Set () was called and the gnomon contains valid info.
true if valid, false if not.
Sets the origin of the gnomon.
Origin.
Initialize this gnomon to the given parameters.
a Mastercam Plane.
true to enable, false to disable.
true if it succeeds, false if it fails.
Get the plane ID of this gnomon.
The identifier.
erase the Plane gnomon; free the memory.
(Optional) true = repaint.
draw the Plane gnomon.
(Optional) true to include the plane name (default = true).
(Optional) true if plane planel active and plane selected (default = false).
(Optional) true to draw as enabled; false to draw as disabled (default = true).
Destructor.
parameterized constructor.
the plane.
true to single instance.
Default constructor.
A plane select gnomon.
Mastercam PlaneGnomon definition to be used for drawing plane gnomons.
Dumps this to the given CStringArray and returns the size.
The size of the CStringArray.
return CString of m_RegenErrors.
The regen errors.
The regen error string.
return value of m_RegenErrors.
The regen errors.
remove associated entity links if we're acting on the current database.
True to delete from associated ent, false just zero out associated ent info in this plane.
True if it succeeds, false if it fails.
Sets the associated entity information in our point.
The creation method (PEC_SLD_FACE, PEC_SLD_POINT or PEC_MESH_FACET).
The associated entity id number and face/facet selection id.
True if it succeeds, false if it fails.
Gets associated entity information embedded in this.
(Optional) True to warn for bad entity data.
a treasure trove of information, nullptr if this point does not reference a solid
face or end point.
Collect copies of the geometry used to define this PlanePoint.
Array to copy geometry entities into.
entity ID and eptr so we don't have to read thru the db.
ID's entities that could not be found in geomMap.
return # of entities copied into array.
Swap the associated geoemtry entity ID's.
old entity ID.
new entity ID.
# of IDs swapped.
set the tvalue CAD entry values.
array of 2 doubles represeting tvalues into.
get the tvalue CAD entry values.
array of 2 doubles to insert tvalues into.
set the tvalue CAD entry values.
array of 2 doubles represeting tvalues into.
get the tvalue CAD entry values.
array of 2 doubles to insert tvalues into.
Query if 'creationMethod' is a PEC_MESH_FACET, PEC_SLD_FACE or PEC_SLD_POINT.
The creation method.
True if associative creation method, false if not.
Query if 'creationMethod' is a PEC_MESH_FACET.
The creation method.
True if mesh creation method, false if not.
Query if 'creationMethod' is a PEC_SLD_FACE or PEC_SLD_POINT.
The creation method.
True if solid creation method, false if not.
Gets creation method description.
The creation method.
The creation method description.
Query if this point is snap point method.
True if snap point method, false if not.
get the point CAD entry method.
returns method if successful.
set the point CAD entry method.
MC_BYTE representing CAD creation method (PEC_ORIGIN, etc)
returns true if successful.
validate creation method.
MC_BYTE representing CAD creation method (PEC_ORIGIN, etc)
returns true if valid.
validate creation method.
MC_BYTE representing CAD creation method (PEC_ORIGIN, etc)
returns true if valid.
Gets the number of valid entity ID's in m_EntityIDs.
The number of valid entity ID's in m_EntityIDs.
set up to two entity ID's that P3D is created with.
the Entity IDs to set.
Previous values.
return two entity ID's that P3D was created with.
return entity ID's that P3D was created with.
convert a P3D to a Mastercam assoc_pt.
the Mastercam assoc_pt to convert into.
convert a P3D to a Mastercam p3d.
the Mastercam p_3d to convert into.
return the P3D m_Point member variable in view coordinates.
the Mastercam view to convert point from world coordinates into.
return the P3D m_Point member variable in view coordinates.
return the P3D m_Point member variable in world coordinates.
The point in world coordinates.
set the origin's Z value in world coordinates.
the value to set Z to.
return the previous Z value.
set the origin's Y value in world coordinates.
the value to set Y to.
return the previous Y value.
set the origin's X value in world coordinates.
the value to set X to.
return the previous X value.
initialize and set P3D m_Point member variable.
Source point.
true to initialise.
.
Sets this point to a Mastercam event.
The event.
MCEvent data containing selection information.
[in,out] True if the event is solid face, false if not.
[in,out] True if the event is wireframe, false if not.
[in,out] The matrix of the selected solid face.
[out] The origin point of the entity --> Center of the entity.
[in, out] The clicked point on the entity. the one used as the origin of the plane.
[in,out] If false, we don't try to associate the plane with any entity
old and new solid link info.
set the version.
the version number.
return the previous version value.
return the version.
The version.
recalculate the point position.
The third m 3.
entity ID and eptr map so it does not have to read thru the db to find geometry entities.
(Optional) True if parent plane is dynamically associated.
return true if successful.
recalculate the point position.
The third m 3.
(Optional) True if parent plane is dynamically associated.
return true if successful.
serialize this.
the destination/source archive object.
subscript operator.
The index.
The indexed value.
zero out all member variables.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator using Mastercam aPoint.
The point.
A shallow copy of this object.
assignment operator using Mastercam assoc_pt.
The point.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
copy constructor.
The object to copy.
destructor.
Constructor for solid face or solid point.
The creation method (PEC_SLD_FACE, PEC_SLD_POINT or PEC_MESH_FACET).
The origin point in world coordinates.
The solid link (solid entity's ent.ent_idn and solid selection id.
parameteritized constructor.
the origin point in world coordinates.
parameteritized constructor.
unique entity ID (ent.en_idn)
unique entity ID (ent.en_idn)
MC_BYTE defining CAD creation method (PEC_ORIGIN, etc)
tValues from CAD creation.
the origin point in world coordinates.
Default constructor.
make Plane a friend.
Forward declaration.
A plane.
A macro that defines no work offset.
Mastercam Plane definition
Inequality operator.
The object to compare.
True if the parameters are not considered equivalent.
Equality operator.
The object to compare.
True if the parameters are considered equivalent.
Default constructor.
Query if this object is valid.
True if valid, false if not.
Inequality operator.
The object.
True if the parameters are not considered equivalent.
Equality operator.
The object.
True if the parameters are considered equivalent.
Less-than comparison operator.
The object to compare with us.
True if the first parameter is less than the second.
Constructor.
(Optional) The associated entity's ent.ent_idn.
(Optional) The selection ID within the entity.
(Optional) The selection ID or the snapped point within the entity.
(Optional) Identifier for the plane.
The map key containing the associated entity's ent.ent_idn and the associated selection ID.
Information about any specific entity associated with this point (currently solids and meshes).
error code applied in validation and regeneration.
PlanePoint class defines a point entity used in creating a Plane.
A plane contains up to 4 PlanePoint's: 1 for the origin and up to 3 to define the 3 axes.
Defines an alias representing array of matrix choices.
Base matrix in [0], CCW 90, 180, 270, CW 0, 90, 180, 270
Determines if transform matrix and origin are Top @ 0,0,0.
True if it transform data doesn't result in any transformation, false if it does.
convert this to a Mastercam x_matrix.
valid X component.
return value of m_r member variable.
.
return value of m_33 member variable.
The 33.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator.
The object.
A shallow copy of this object.
Initialize member variables.
subscript operator - return XCOORD, YCOORD or ZCOORD.
The index.
The indexed value.
serialize this.
the destination/source archive object.
construct from 3 P3D's.
valid X component.
valid Y component.
valid Z component.
valid T component.
assignment operator using Mastercam's x_matrix.
The object.
A shallow copy of this object.
construct from matrix_33.
the Mastercam x_matrix to copy from.
construct from matrix_33.
the Matrix33 to copy from.
the P3D to copy from.
copy constructor.
The object to copy.
destructor.
Default constructor.
Test matrix's components to see if they're all of zero value (like someone did a memset(0).
True to display debug warning.
True if all zero, false if not.
Check dot product of given Matrix33.
The Matrix33 to check.
MatrixError::None for no error, MatrixError::DotProduct for bad dot product,.
Check dot product of this.
(Optional) the warning.
MatrixError::None for no error, MatrixError::DotProduct for bad dot product,
MatrixError::DotProductOrthoNormalize for bad dot product that can be correct by re-orthonormalizing
option to ASSERT.
true if the operation was a success, false if it failed.
convert a P3D in view coordinates to view coordinates in a different view.
the P3D in view coordinates to convert.
the view the point resides in.
the destination view.
return new pt.
convert thePt in view coordinates to world coordinates then subtract wSubPt.
the P3D in view coordinates to convert.
the point to subtract in world coords.
return new pt.
convert thePt in view coordinates to world coordinates then add wAddPt.
the P3D in view coordinates to convert.
the point to add in world coords.
return new pt.
add wAddPt from thePt, convert thePt to view coordinates.
the P3D in world coordinates to convert.
point in world coordinates to subtract.
return new pt.
subtract wSubPt from thePt, convert thePt to view coordinates.
the P3D in world coordinates to convert.
point in world coordinates to subtract.
return new pt.
Multiply a 3x3 matrix by a 3 element vector.
A column vector.
Result.
Convert a point from view coordinates in the given matrix coordinates to world.
The point in view coordiantes.
A point in world coordinates.
Convert a point from world coordinates into given matrix coordinates.
The point in world coordinates.
A point in view coordinates.
check and correct bad matrix if needed.
true = use MakeViewK() if all else fails.
(Optional) true = show debug warning if invalid.
return true if valid.
re-orthonormalize via Gram-Schmidt algorithm.
(Optional) Which axis (X, Y or Z) is priority. Z is the default).
true if it passes dot product check, false if it fails.
correct bad matrix_33 type.
[in,out] The matrix to fix.
true = use MakeViewK() if all else fails.
(Optional) Which axis (X, Y or Z) is priority. Z is the default).
first = matrix is valid, second = values were adjusted to make valid.
correct bad matrix.
true = use MakeViewK() if all else fails.
(Optional) Which axis (X, Y or Z) is priority. Z is the default).
first = matrix is valid, second = values were adjusted to make valid.
Gets the dirty.
return value of m_Dirty.
set value m_Dirty.
true=dirty, false=clean.
return previous value.
calculate the axis rotation angle from this with to the m33.
Matrix33 to compare to.
return P3D of axis rotations in radians.
Convert this with a given k component.
k component.
return true if successful.
Multiply two 3x3 matrices.
a Matrix33 object.
return result.
return CString of coordinate values.
(Optional) number of places behind the decimal point.
The formatted string.
set the tolerance.
the tolerance.
.
Sets our tolerance to tight GetTightTol ().
Return the previous value of m_Tol.
Gets the tightest tolerance.
The tight tolerance.
return value of m_Tol.
This matrix's tolerance.
Builds and returns a set of tolerances we use to match matrices when searching.
The maximum tolerance.
The match tolerances.
set this to TOP.
zero out all member variables.
Gets the X, Y or Z component.
The X, Y or Z component.
The component.
set value of Z component.
new XCOORD value of Z component.
new YCOORD value of Z component.
new ZCOORD value of Z component.
return previous Z component.
set value of Z component.
new Z component value.
return previous Z component.
return P3D Z component.
The z coordinate.
set value of Y component.
new XCOORD value of Y component.
new YCOORD value of Y component.
new ZCOORD value of Y component.
return previous Y component.
set value of Y component.
new Y component value.
return previous Y component.
return P3D Y component.
The y coordinate.
set value of X component.
new XCOORD value of X component.
new YCOORD value of X component.
new ZCOORD value of X component.
return previous X component.
set value of X component.
new X component value.
return previous X component.
return P3D X component.
The x coordinate.
rotate a Matrix33 about an axis by degrees.
the X, Y or Z axis to rotate about.
rotation amount in degrees.
return true if successful.
Flip this matrix's Z axis about its X axis.
return true if successful.
Flip this matrix's Z axis about its Y axis.
return true if successful.
Flip this matrix by an axis.
XCOORD, YCOORD or ZCOORD.
(Optional) if flipping Z axis, rotate about X or Y axis.
return true if successful.
Return true if all values in this are valid.
(Optional) true = debug only warning.
(Optional) true = ignore m_Dirty value and check values.
[in,out] (Optional) If non-null, (Optional) the matrix error.
Return true if matrix is mathematically correct.
test Matrix33 for 'left-handed' defintion.
(Optional) the warning.
returns true if invalid values exist within m33.
convert Matrix33 to matrix_33.
the destination matrix_33.
return true if Matrix33 is parallel with given Matrix33.
3x3 matrix to compare to this.
set to true if component is in the opposite direction.
(Optional) The axis to check.
(Optional) The dot tolerance.
return true if Matrix33 is parallel with given Matrix33.
Gets parallel information of this compared to m33.
The matrix to compare to this.
(Optional) The parallel axis (XCOORD, YCOORD or ZCOORD).
(Optional) The dot tolerance.
The parallel information.
align axis of this to given matrix's axis.
3x3 matrix to align axis to.
X, Y or Z axis to align.
true if it succeeds, false if it fails.
return true if ALL view axes are aligned.
The matrix to compare.
true if axis aligned, false if not.
return true if the requested axis is aligned with given axis.
The matrix to compare.
The axis no (XCOORD, YCOORD or ZCOORD).
Allow opposite direction comparison.
true if axis aligned, false if not.
serialize this.
the destination/source archive object.
Return true if ortho-normalized Matrix33 is equal within a tolerance.
another Matrix33 to compare this with.
(Optional) match tolerance.
Return true if equal.
For debugging only - build and return a vector of 3 strings with the difference in
each of the vectors.
The matrix to compare with this.
Accuracy of double format in string.
Normalize matrices before calculating difference.
(Optional) If not null, output debug strings to VS output window.
Vector of strings with the difference in each vector.
Query if 'obj' is exactly equal (double == double).
The matrix to compare to.
True if exactly equal, false if not.
Query if this object is an identity matrix (top).
True if identity, false if not.
Return true if Matrix33 is equal within a tolerance.
Another Matrix33 to compare this with within the minimum of each objects tolerance.
Match tolerance.
Return true if equal within tolerance.
Greater-than comparison operator. Use for std::map when a key.
The matrix to compare.
true if the first parameter is greater than to the second.
Less-than comparison operator. Use for std::map when a key.
The matrix to compare.
true if the first parameter is less than the second.
comparison operator.
The matrix to compare.
true if the parameters are not considered equivalent.
comparison operator.
The matrix to compare.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator using a matrix_33.
The third m 3.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
subscript operator - return XCOORD, YCOORD or ZCOORD.
The index.
The indexed value.
subscript operator - return XCOORD, YCOORD or ZCOORD.
The index.
The indexed value.
construct from a_3d.
arc info.
construct from 3 P3D's.
k component.
construct from 3 P3D's.
valid X component.
valid Y component.
valid Z component.
construct from matrix_33.
the matrix_33 to copy from.
copy constructor.
The object to copy.
destructor.
Default constructor.
Default constructor.
Information about the parallelism of a compared matrix.
Values that represent invalid components of a Matrix33.
Constructs a Matrix33 object to be used instead of Mastercam's matrix_33
return the 3D distance between a P3D and a L3D.
the point.
the line.
return the distance between to P3D's.
convert and return this L3D in l_3d format.
object converted to a l 3D.
get point #2 of this L3D.
the p_3d to copy it into.
get point #2 of this L3D.
the p_3d to copy it into.
get point #2 of this L3D.
The point 2.
set point #2 of this L3D.
The second point.
return previous value.
get point #1 of this L3D.
the p_3d to copy it into.
get point #1 of this L3D.
the p_3d to copy it into.
get point #1 of this L3D.
The point 1.
set point #1 of this L3D.
The first point.
return previous value.
serialize this.
the destination/source archive object.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator using a l_3d.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
copy constructor.
The object.
copy constructor.
The object.
parameteritized constructor from 2 P3D's.
The first point.
The second point.
destructor.
Default constructor.
Constructs a L3D object to be used instead of Mastercam's l_3d
set relative WCS ID.
Identifier for the relative wcs.
return previous value.
return relative WCS ID.
The relative wcs identifier.
set parent plane ID.
Identifier for the plane.
return previous value.
return parent plane ID.
The plane identifier.
assignment operator for plane ID.
Identifier for the plane.
A shallow copy of this object.
assignment operator for P3D.
The point.
A shallow copy of this object.
destructor
copy constructor.
The object.
construct from P3D and a plane ID.
The point.
(Optional) identifier for the plane.
Mastercam P3DS definition (same as P3D, but contains parent Plane ID and m_RelativeWcsID).
For debugging only - build and return a string with the difference.
The P3D to compare with this.
Accuracy of double format in string.
Vector of strings with the difference in each vector.
return the 3D distance between to P3D's.
point #2 of 2.
(Optional) return 2D distance instead of 3D.
return the distance between to P3D's.
return CString of coordinate values.
(Optional) number of places behind the decimal point.
The formatted string.
return the angle formed by two 3d vectors.
P3D representing a vector.
return the angle in radians between v2 and this.
apply a scalar to the values.
the scalar.
### return scaled P3D or this.
negative of a 3D vector.
return the negative of a 3D vector.
Find the cross product (vector product) of this and the given vector.
the 2nd vector.
return the cross product.
Find the dot product (scalar product) of this and the given vector.
the 2nd vector.
return the dot product.
normalize and return the vector.
.
Determine if vector is parallel to this.
The second P3D.
true if it succeeds, false if it fails.
calculate and return the length of the vector.
.
find the linear combination of two 3d vectors.
The fac.
The first point.
The fac.
The second point.
return the combination.
get the values in p_3d format.
the destination p_3d.
zero out all member variables.
set value of tolerance.
new tolerance value.
return previous value of tolerance.
return tolerance value.
The tolerance.
set XCOORD, YCOORD and ZCOORD values.
new XCOORD component value.
new YCOORD component value.
new ZCOORD component value.
Gets a const pointer to the X, Y or Z component.
The X, Y or Z component.
The const pointer, nullptr if invalid XYorZ value.
Gets the X, Y or Z component.
The X, Y or Z component.
The component.
set value of ZCOORD component.
new ZCOORD component value.
return previous value of ZCOORD component.
return ZCOORD component.
return XCOORD component.
set value of YCOORD component.
new YCOORD component value.
return previous value of YCOORD component.
return YCOORD component.
return YCOORD component.
set value of XCOORD component.
new XCOORD component value.
return previous value of XCOORD component.
return XCOORD component.
return XCOORD component.
serialize this.
the destination/source archive object.
Query if 'obj' is exactly equal (double == double).
The P3D to compare to.
True if exactly equal, false if not.
Return true if P3D is equal within a tolerance.
another P3D to compare this with.
match tolerance.
Return true if equal.
subscript operator.
The index.
The indexed value.
subscript operator.
The index.
The indexed value.
Greater-than comparison operator.
The object.
true if the first parameter is greater than to the second.
Less-than comparison operator. Use in std::map as a key.
The object.
true if the first parameter is less than the second.
comparison operator.
The object.
true if the parameters are considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
comparison operator.
The object.
true if the parameters are not considered equivalent.
assignment operator using a const a p_3d.
The point.
A shallow copy of this object.
assignment operator using a const double * pointing to a p_3d.
The object.
A shallow copy of this object.
assignment operator.
The object.
A shallow copy of this object.
addition-assignment operator.
The object.
The result of the operation.
subtraction-assignment operator.
The object.
The result of the operation.
copy constructor.
The object.
destructor.
construct from XCOORD, YCOORD & ZCOORD.
The xval.
The yval.
The zval.
construct from p_3d.
The point.
parameteritized constructor from double ptr pointing to a double[3].
The double.
Default constructor.
Mastercam P3D definition.
Return value for Set() and Replace()
Values that represent CoordinateDisplayType.
Values that represent class of plane.
Plane types.
Gets the last identifier, 0 on error.
The last identifier.
Query if 'obj' is equal contents to this.
The object to compare.
true if equal contents, false if not.
Returns reference to m_ExcludeIDs.
reference to m_ExcludeIDs.
Query if this object has excluded operation IDs.
true if excluded operation IDs exist, false if not.
Add the given ID to the exclude mask (exclude this ID from being added to or
existing in the array. Any existing matching ID's will be removed from the array.
The ID to exclude.
(Optional) first empty exclude mask.
Removes all instances of the ID from the array.
The ID to remove.
Size of array.
Sets new size of array.
The new size.
Size of array.
Gets value of m_AllowNegatives.
value of m_AllowNegatives.
Gets value of m_AllowDuplicates.
value m_AllowDuplicates.
Sets m_AllowDuplicates and removed duplicate IDs from the array.
true to allow, false to deny duplicates.
(Optional) true to ensure contents are unique.
Previous value of m_AllowDuplicates.
Gets sort mode.
The sort mode.
Sorts the array per the given sort mode.
(Optional) the sort mode.
Use this member function to copy the elements of one array to another.
Source of the elements to be copied to an array.
Returns true if successful.
Appends the given set to this.
Source of the elements to be appended to an array.
The index of the first appended element.
Appends the array of long ID's at pOpIDs.
The ptr to the operation IDs.
The number operation IDs.
The index of the first appended element.
Appends the given array to this.
Source of the elements to be appended to an array.
The index of the first appended element.
Adds the ID to the array.
the identifier to add.
.
Query if this object is empty.
true if empty, false if not.
Assignment operator.
The object to copy.
A shallow copy of this object.
Assignment operator.
The object to copy.
A shallow copy of this object.
Assignment operator.
The object.
A shallow copy of this object.
Destructor.
Constructor that accepts a set of longs.
std::set of longs.
Constructor that accepts a set of longs.
std::set of longs.
Copy constructor.
The object.
Constructor.
(Optional) allow duplicates IDs in the array.
(Optional) the sort mode.
A std::vector of long data types used for operation ID's.
Defines an alias representing the solid hole axis data change vector.
Solid hole axis data change item.
Solid hole axis data change status.
Defines an alias representing options for controlling the detect hole axis.
Output data for a single cylindrical "hole" from SDetectSelectHoleAxis function.
Solid Detection - conical face structure
Solid Detection - cylindrical face structure
@defgroup Contour_Types Contour types
@{
@}
@defgroup Pocket_Types Pocket types
@{
@}
V9 Solids drill detection parameters
probe toolpath parameters.
A probe parameter.
toolpath nesting parameters.
solid drill toolpath parameters.
Solid drill detection parameters.
automatic drilling parameters
trimmed toolpath parameters.
manual entry parameters.
chook operation.
Values that represent dependency modes in CHook operations.
coons parameters.
swept 3D parameters.
swept 2D parameters.
lofted parameters.
revolved parameters.
ruled parameters.
helix bore parameters.
slotmill parameters.
thread mill parameters.
operation parameters - ADV 5 axis.
Declarations in 3rd party package: const int mcamParamsManager::MPM_MAX_CHOOK_PARAMS=470;
const int mcamParamsManager::MPM_MAX_FURTHER_CHOOK_PARAMS=(147+8+13);
const int mcamParamsManager::MPM_MAX_V8_PAD_PARAMS=250;
const int mcamParamsManager::MPM_MAX_V8_PADX_PARAMS=28;
operation parameters - circle 5axis specific parameters.
circmill parameters.
operation parameters - Port 5 axis.
operation parameters - slice 5 axis.
no longer used but leave to retrieve values from older .mc9 files
operation parameters - Msurf 5 axis.
Box Pattern data.
Sphere Pattern data.
Support structures for Msurf 5 axis
Cylinder Pattern data.
operation parameters - swarf 5 axis.
@}
@defgroup cc5dlg_parameters1 CC5dlg parameters
@{
operation parameters - curve 5 axis.
@}
@defgroup cm5dlg_parameters4 CM5dlg parameters
@{
operation parameters - surface finish 4 axis.
@}
@defgroup cm5dlg_parameters1 CM5dlg parameters
@{
operation parameters - surface finish flowline 5 axis.
Exit_Blend Parameters.
Point generators.
multiaxis oscillate settings.
multiaxis overlap settings
multiaxis entry and exit.
multiaxis entry or exit.
operation parameters - surface hmm.
This structure is written and read from disk. Practices to follow when adding new parameters:
1. Look for "gaps" between data members that result from data alignment and will not change the alignment of subsequent data members.
2. Look for data members named pad_short, pad_int, etc. These are memory pads that are no longer used if you fail to find a "gap" in the structure.
3. Backward compatibility may need to be addressed after adding or modifying a data member as follows:
a. Edit INTERFACES\GUI\ChkSIM_E.h and pump up the minor version - V20XX_MINOR - and add a new one V20XX_'whatever describes the change' set to the old minor version,
b. older versions are handled by editing files MastercamX\\MCPrvVerFile\\V20XXTentToV20XY.cpp, and
b. minor versions are handled by editing the file MCCore\\DbLoIO.cpp.
Padding, from structure packing alignment or "unused" padding variables, can be expected to be zeroed out, and, thus, the newly introduced variable that was squeezed into
an existing gap in the structure will also be zeroed out. In this case, there's no need to bump-up the minor version. But, if the new data members require
special initialization, (3) will be needed. For examples on how this could be done, you may want to look at revision 196292 where the data members limitXYOption and
includeStockXY were introduced.
A helpful tool to identify alignment gaps are the compiler flags /d1reportSingleClassLayoutXXX and /d1reportAllClassLayout. They provide a memory layout of the
structure with the available memory identified as 'alignment memory'.
operation parameters - surface finish constant scallop.
operation parameters - surface finish shallow.
operation parameters - surface finish steep.
operation parameters - surface finish leftover.
operation parameters - surface finish pencil.
operation parameters - surface finish contour.
operation parameters - surface finish flowline.
operation parameters - surface finish blend.
operation parameters - surface finish project.
operation parameters - surface finish radial.
operation parameters - surface finish parallel.
operation parameters - surface rough plunge.
operation parameters - surface rough pocket.
operation parameters - surface rough rest mill.
operation parameters - surface rough contour.
operation parameters - surface rough flowline.
operation parameters - surface rough project.
operation parameters - surface rough radial.
operation parameters - surface rough parallel.
operation parameters - surface operation's limit settings.
operation parameters - surface operation's roughing settings.
operation parameters - surface operation's depth settings.
operation parameters - surface high speed parameters.
operation parameters - surface operation's direction settings.
operation parameters - surface operation's edge settings.
operation parameters - surface operation's gap settings.
operation parameters - common parameters for all surface operations.
operation parameters - model chamfering.
operation parameters - 2D toolpaths hmm.
A collection of link lead motions and other data for first/last leads.
Initialize link lead motion to the defaults.
Inequality operator.
The right hand side of the structure to test against.
True if the structures are not considered equivalent.
Equality operator.
The right hand side of the structure to test against.
True if the structures are considered equivalent.
A prm hmm link lead motion.
Facing.
Pocket.
Note: if you increase the size of prm_pocket, adjust padding at end of prm_srf_rgh_pocket, too.
HEM parameters.
Thinwall pocket.
High speed pocket options.
Open pockets.
Pocket remachining.
operation parameters - pocket specific parameters.
operation parameters - pocket specific parameters.
operation parameters - pocket specific parameters.
operation parameters - pocket specific parameters.
operation parameters - pocket specific parameters.
Custom operation parameters.
lathe park turret operation.
turret operation.
center point operation.
tailstock operation.
spindle sync operation
Exact rotary direction types.
Exact rotary type as in values that explicitly state the rotary direction.
A different way to specify rotary (or spindle) direction is to say "shortest",
but that should have its own enumeration to clearly differentiate between usages.
Spindle sync operation types.
spindle advance/retract operation
Spindle move operation types.
chuck clamp/unclamp operation.
bar feed operation.
miscop axis motion description.
lathe steady rest position operation.
lathe tailstock position operation.
lathe chuck clamp/un-clamp operation.
lathe stock bar feed operation.
lathe stock flip operation.
lathe stock transfer operation.
lathe pattern repeat toolpath.
lathe canned finish toolpath.
lathe canned rough toolpath.
lathe point toolpath parameters.
lathe thread toolpath parameters.
lathe thread cut parameters.
lathe thread shape parameters.
lathe plunge and turn toolpath parameters.
lathe plunge and turn finish parameters.
lathe plunge and turn rough parameters.
lathe groove toolpath parameters.
lathe groove finish parameters (not used with 2 boundary groove)
lathe groove rough parameters.
lathe groove roughing step removal parameters.
Lathe groove rough rib cutting parameters.
Lathe groove rough rib cutting rib width.
Lathe groove rough cut direction.
lathe groove rough multiple depth cut parameters.
lathe groove shape parameters (not used with 2 boundary groove)
Lathe groove geometry type.
clearance cut
lathe cutoff toolpath parameters.
lathe cutoff toolpath feed speed parameters.
lathe cutoff toolpath canned text parameters.
lathe corner parameters.
dwell parameters
retract parameters
peck parameters
lathe peck/dwell parameters.
lathe pinch turn operation.
Lathe pinch turn sync type.
Lathe pinch turn pinch type.
Lathe pinch turn dwell type.
Lathe pinch turn first cut.
Lathe prime turning parameters.
Lathe prime turning finish parameters.
Lathe prime turning finish strategies.
Lathe prime turning rough parameters.
Lathe prime turning rough strategies.
Lathe prime turning common parameters for rough and finish.
Feed rate and spindle speed parameters, used by prime turning finish.
Feed rate and spindle speed parameters, used by prime turning rough.
lathe contour rough toolpath parameters.
lathe dynamic rough toolpath parameters.
lathe rough toolpath parameters.
Lathe semi finish feed/speed parameters.
lathe pinch turn parameters.
lathe finish toolpath parameters
Lathe cut direction.
lathe finish down cutting parameters
lathe corner break parameters.
lathe face toolpath parameters.
Lathe secondary feed/speed parameters.
lathe face corner parameters.
lathe plunge parameters.
lathe entry/exit parameters.
individual lathe entry/exit parameters.
lathe drill toolpath parameters.
Process hole toolpath parameters.
Chamfer drill toolpath parameters.
Toolpath parameters for a Advanced Drill operation.
operation parameters - drilling specific parameters
Process hole linking options.
Process hole linking options.
Process hole sorting options.
multiaxis trim to stock settings.
Lathe chip break parameters.
lathe tool inspection parameters.
Minimum tilt parameters.
Axis limit property page.
multiaxis axis limit.
operation parameters - contour specific parameters.
Please note: if you change prm_contour, please adjust other structures (such as prm_2d_hmm and
prm_chamfer) which include it.
Contour oscillate.
Tab parameters.
router common parameters.
Extend/shorten contour.
Contour ramp.
Contour chamfer.
@defgroup operation_parameters_common_contour_and_pocket_parameters operation parameters - common contour and pocket parameters
* @note get rid of this pathetic data structure for version 9.
* Move finish_all to op_multi_cuts. Use op_common.cmp_to_tip
@{
Contour pocket.
Contour remachining.
operation parameters - xform toolpath.
operation parameters - xform toolpath misc ops.
operation parameters - xform-translate (linear array) toolpath.
operation parameters - xform-rotate toolpath.
operation parameters - xform-mirror toolpath.
operation parameters - xform-view info.
operation parameters - safe link.
A 5 safety zone.
Block safety zone anchor points.
Cylinder safety zone anchor points.
Values that represent safety zone wrap types.
Values that represent safety zone link tool options.
Values that represent safety zone types.
wire 4axis wirepath parameters.
wire point wirepath parameters.
wire nocore wirepath parameters.
wire canned cycle wirepath parameters.
wire contour wirepath parameters.
Wire tab parameters.
wire window chain sorting parameters.
wire entry/exit parameters.
wire common parameters.
operation parameters - miscellaneous integers and reals.
toolpath entity definition.
If a tp_entity member is added between flag and u and the new member is not supposed to be part of the
tp_entity header, the define below must be changed to use the new member in place of u.
toolpath entity - Stock Model Result entity.
toolpath entity - FBM zone control entity.
toolpath entity - FBM chain control entity.
toolpath entity - FBM chain boundary entity.
operation id entity.
assoc info.
toolpath entity - Nesting group info.
toolpath entity - Nesting Group entity.
toolpath entity - Nesting Part operation id # entity.
toolpath entity - Nesting Part entity.
toolpath entity - Nesting Sheet entity.
toolpath entity - Router tab entity.
CHook Toolpath Structure.
group entity.
Information about the 3D HST variable stock group.
HST surface type.
surface entity - surface info
toolpath drilled hole feature.
toolpath entity - arc from solid information.
V8 SDetect Drill Geometry Structure.
Drill hole segments used by the Advanced Drill toolpath for creating deep hole drilling operations.
Advanced Drill ordered item type.
Peck type.
Spindle direction.
toolpath entity - drilling point from solid information.
toolpath entity - 5axis position information.
toolpath entity - drilling point information.
Linking parameters associative point type enumeration.
toolpath entity - drilling grid information.
toolpath entity - drilling bolt circle information.
toolpath entity - manual entry.
toolpath entity - chain control entity.
toolpath entity - chain boundary entity.
toolpath entity - modify chain information.
toolpath entity - thread cut entity (Used in Wire only)
toolpath entity - chain sync entity.
toolpath entity - chain boundary entity.
Lathe secondary feed/speed location type.
Lathe feed from types.
Lathe feed rate types.
Lathe entry/exit feed rate mode.
Lathe entry/exit mode.
Defines an alias representing the gcode mask.
Values that represent nci gcodes.
for linked lists of head tool entities.
Information about the block tool.
for linked lists of lathe tool entities
for linked lists of mill tool entities
Tool reference information.
holder segment definition.
tool definition.
tool parameters - Multi tool head specific -block tools/drills/aggregates.
tool parameters - drill specific.
tool parameters - mill specific.
operation parameters - common tool parameters for all operation types.
Maximum number of components in an axis combination that can be handled
by the post
axis combo information in an MP friendly format
Maximum number of components in an axis combination that can be handled
by the post
axis combo information in an MP friendly format
data stream names
machine supports event-based programming - post must match
version number major.minor starting with 11.2 (X2 MR2)
automatically load tools when changing MGP machines
does the machine support RTCP
unique identifier for this machine
default construction plane
maximum wire taper angle (deg)
holder catalog file
insert catalog file
ent_idn of list of machining modes
ent_idn of list of axis combination entities
ent_idn of of list of machine reference positions
ent_idn of 1st component group entity
ent_idn of machine base component entity
ent_idn of related control definition
ent_idn for the cnc machine entity (this one!)
use the toolbar state
name of tool bar state to load with machine
comment to describe the machine
material library file (inch, mm)
tool library files (inch, mm)
post-processor file
control definition file
coolant
toolpath operation feedrate limits - inch, mm / min, deg/min, 1/sec
global maximum machine axis feedrates
for rent
Machine simulation info entity id.
MT .machine configuration GUID - gets assigned when the machine is loaded into a machine group
macro event lists
event defaults event list
machine dynamics information for high-feed machining
and operation timing calculations
multi-axis motion control
lathe default WCS - 0 = none, 1 = top, 2 = LATHEZ=WORLDZ
Is this a VTL? (lathe only)
machine type (mill, lathe, router, wire EDM currently supported)
@}
CNC machine definition
machine motion acceleration value
@}
@defgroup dynamic information NOT for high-feed
@{
timing increment for MATSS sync-list
cornering acceleration
corner radius
feedrate to slow down to at sharp corners
minimum change in direction to slow down to min_corner_fr
segment length as % of tool diameter
apply acceleration
maximum feedrate change per block
look-ahead as a percentage of tool diameter
@defgroup parameters taken from HighFeed_E.h
@{
maximum change in feedrate to recombine segments (%)
Machine dynamic parameters
maximum combined angle before break is required
break combined rotary axis motion
@defgroup cnc_machine_parameters CNC machine parameters
@{
Multi-axis motion control
ent_idns of this and related entities in database\n
ent_idns.thisEnt is used as the group reference stored with operations
ent_idn for 1st component in group
ent_idn for 1st component group parameters entity in the list
! DEPRECATED ! Old Component group definition. Since 2020, replaced by CComponentGroup class members.
ent_idns of this and related entities in database
specific group type (UL_TOOLS_GROUP, etc.)
general component group class (PART_HOLDING_GROUP_TYPE, etc.)
Component group parameters
@brief Component group parameters
A linked list of these parameters is stored with a component group.
This allows a group to have the parameters of more than one group type.
For example, a component group can have both turret and spindle parameters.
The turret and spindle specific parameters are stored in different entries
in the list
component type specific parameters
geometry definition parameters (non-component specific)
type of geometry used to define the component
ent_idn of owner machine
ent_idns of this and related entities in database
current position of anchorPt (world coordinates)
= anchorPt position on the machine at start of program most of the time... [REMOVE]
transformation matrix to put component @ current NC position
= initXform initially [REMOVE]
color to draw component
type of component (machine base, chuck, turret, etc)
component group id
@}
CNC machine component parameters
aggregate head parametric geometry definition
work offset number
tool length
tilt angle
machine view angle
X,Y,Z station position
X,Y,Z block anchor position
tool change type
Orientation axis
Aggregate type
station/block number
Aggregate head component parameters
turret face number on which this gang is installed (if any...)
angle of slant bed that gang is installed on
used for determining tool alignment in tool location components
min./max. spindle speed for live tools
Gang tool component parameters
flags for applying the stickout values
default 'stickout' lengths for auto tooling the turret
slant angle (deg.) - used for computing the axis of rotation and indexed tool vectors
min./max. spindle speed for live tools
turret parametric geometry definition
CW, CCW, OPTIMIZE
number of tool stations defined
time to index between adjacent faces (sec.)
defines direction of tools in indexed position
must be perpendicular to rotaryAxis
axis of turret rotation
defines CW/CCW direction for auto-face numbering
Turret component parameters
Tool spindle component parameters
This also applies to the turning tool device that works on machines that
use an ATC for turning tools
'standard' geometry types are supported
@}
@defgroup multi_tool_component_types Multi-tool component types
@{
Automatic tool changer (ATC) component parameters tool change kinematic simulation is not currently supported, this component is
necessary: to provide tool change times so machine simulation knows where to send
the tools for a tool change 'standard' geometry types are supported.
Tool component type
X,Y,Z spacing for the stations
Multi-head piggyback component parameters
X,Y,Z spacing for the stations
Multi-head head component parameters
station geometry definition
station geometry type
block geometry definition
block geometry type
X,Y,Z position for the stations
X,Y,Z block Anchor position
station/block number
Router drill block station component parameters
guide geometry
Wire lower guide component type
guide geometry
align guide vertically with lower guide at home position
thread time (sec)
Wire upper guide component type
geometry
wire guide geometry type
for rent
allow fixed (Lathe) drilling tools at this location
allow live (Mill) tools at this station
allow fixed (Lathe) tools at this location (NOT lathe drills!)
allow face tools at this location
allow cross tools at this location
use this locator for any tool, irregardless of the tool station #
tool station number to match on
use this locator for all turret index or gang tool positions
reference point on tool for this locator
method by which the user defined the tool transformation view
tool transformation matrix named view v_idn
use the stickout value
stickout length for the tool
gang tool position ID for a tool
turret face number for a tool
ATC pocket for a tool
position and orientation tool for this location
used for pre-defined tool position and orientation for spindles, turrets,
and gangs
@}
@defgroup single_tool_component_types Single tool component types
@{
Steady rest component parameters
Steady rest structure (X)
Tailstock component parameters
Tailstock structure (X)
Centre component parameters (live or dead centre, no taper is modelled)
This is a special component added directly from the MGP stock setup page
@}
@defgroup programmable_misc_tooling_component_types Programmable misc tooling component types
@{
Centre component geometry (live or dead centre, no taper is modelled)
Guide bushing component parameters
parametric geometry definition
Collet component parameters
- not implemented currently in Mastercam X
Chuck component parameters
Chuck geometry type
Chuck jaw(s) component
This is a special component added directly from the MGP stock setup page
Chuck jaw stock stickout
Chuck jaw geometry
Machine vise component parameters
- not implemented currently in Mastercam X
@}
@defgroup work_holding_comp_types Work Holding Component Types
@{
Machine vise jaw component parameters
- not implemented currently in Mastercam X
Wire EDM table component parameters
Round table component parameters
- not implemented currently in Mastercam X
Rectangular table component parameters
Rectangular table geometry - not implemented currently in Mastercam X
T slot parameters - not implemented currently in Mastercam X
disable feedrate programming for axis motion events
simulation startup axis angle
min/max rotational travel limits (deg.)
maximum feedrate (deg/min)
maximum angular move before breaking
use chordal deviation to determine when to break
break rotary move
signed continuous, signed direction (0-360 deg),
shortest direction (0 - 360 deg)
must divide evenly into 360
is this an indexing axis?
rotational reposition limits (deg)
angle of rotation for nutated axis, right hand rule (degrees)
axis of rotation for axis out of plane (WCS axis!)\n
* X_AXIS, Y_AXIS, Z_AXIS\n
* NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS\n
nutated machine axis
true = CW is +ive direction for this axis
axis '0 deg' vector WRT machine axes
lies in plane perpendicular to axis of rotation
axis of rotation wrt machine linear axes
rotary axis to drive on the machine: A_AXIS, B_AXIS, C_AXIS, MACRO_AXIS
Rotary axis component parameters
disable feedrate programming for axis motion events
max. feed rates (rapid traverse rates)
axis to drive on the machine: X_AXIS, Y_AXIS, Z_AXIS, MACRO_AXIS
[0] = parameters for the physical axis direction on the machine
[1] = parameters for the programmed direction of machine motion for this axis,
which may be in combination with other linear axes, if the machine axes are
non-orthogonal
Linear axis component parameters
simulation startup axis position
min/max linear travel limits (in/mm) measured along axis direction from zeroPos
angle of rotation for tilt, right hand rule (degrees)
axis of rotation for axis out of plane (WCS axis!)\n
* X_AXIS, Y_AXIS, Z_AXIS\n
* NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS\n
tilt the axis
base axis direction WRT the WCS:
X_AXIS, Y_AXIS, Z_AXIS
NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS
generic axis component parameters
The actual axis direction vector is computed by taking the wcsAxis
vector direction and rotating it about the tiltAxis by rotAngle
travel limits
Axis feed rates
General fixture component parameters
Machine base component parameters
Miscellaneous component parameters
round barstock geometry with stock margins
other stock types defined using standard solid types
Stock component type
@}
@defgroup generic_comp_types Generic Component Types
@{
Round bar stock (with optional hole) structure (X)
Cylinder with a hole in it (revolved component)
Other specialized geometry geometry definitions
Filleted polygon
'Standard' solid component definition defaults
Parameters for a component definition from a revolved profile
Parameters for a component definition from an extruded profile
Parameters for a component definition from a cylinder
Parameters for a component definition from a block
Parameters for a component definition from a STL entity
Component Geometry Definitions
Component geometry will provide the backbone for machine simulation in
future releases of Mastercam. It will also enable graphical descriptions
of CNC machines, currently provided via post-processor variables
Component geometry is NOT supported in the current version of Mastercam
@defgroup component_geometry_definitions Component Geometry Definitions
@{
Parameters for a component definition from a solid entity
Component group types - These are used to tell the machine tool the specific
purpose(s) of a group of components.
@par Rules:
- A component group may have multiple types simultaneously.
- A machine may only have 1 of each component group type.
Lathe-specific miscellaneous tooling groups
Miscellaneous tooling component groups
These groups contain auxiliary machine automation, not related to
holding/driving the part or tool
Mill-specific miscellaneous tooling groups
Wire-specific tool storage groups
Router-specific tool storage groups
Lathe-specific tool storage groups
Cutting tool storage component groups
Mill-specific tool storage groups
Wire-specific part holding groups
Router-specific part holding groups
Lathe-specific part holding groups
Mill-specific part holding groups
'closed loop' tool storage device (carousel, turret, chain ATC)
index methods.
Rotary axis positioning types.
Component motion types defines vector motion along or rotational motion about a
machine axis.
Tool location positions on the back of a tool holder.
This is used for the legacy tool locator, not for MT tool locator.
The legacy tool locator is converted to MT tool locator when loading
the file.
Tool orientations in a tool location component.
This is used for the legacy tool locator, not for MT tool locator.
The legacy tool locator is converted to MT tool locator when loading
the file.
Component geometry types Component geometry may be defined using one of the
following methods:
- component-specific parametric geometry
- solid block or cylinder
- extruded or revolved (360 deg only) profile
- Mastercam solid entity
Component geometry definition is NOT supported in the current version of
Mastercam.
Machine type
group view structure
Type codes for the machine components.
Used to identify variables in the above enum.
misc. tooling components, ATC included as tool components only
hold tools while cutting
Multi-cutting tool components
Single tool holding components
Work holding components
(tables included, as the part can sit on a table)
Generic components
Components marked with an * aren't available currently in X2
Multi-tasking machining mode
Multi-tasking data stream information for a machining mode
ent_idn for lists of components (this list is stored in the database as an ent_idn_list)
component lists for this axis combination
- each list consists of components from 1 component group
- one list is for the tool holding components
- the other is for the part holding components
- miscop operations (ex. tailstock advance) may only require one list
- this list should be the first one
ent_idns of component groups to which all components belong
Tool change (V9 home) position (inch, mm)
Axis combination name
@par Machining mode axis combination
@note Rules:
- Any 'cutting' toolpath operation requires the interaction of 2
component groups and their components, hence 2 component lists.
- Only one of each linear axis + 2 different rotary axes are allowed.
- Tool and part holding components must NOT be stored in the same
component list. (Each list must have one or the other.)
event list information
Machine reference position type and method of positioning
Reference position source (how it was created)
Type of reference position
The next 2 members are used for axis combination reference POINTS and home position only.
array of data stream names
Alias for vector of tp_ents (boundary geometry).
Alias for shared_ptr to a vector of tp_ents (boundary geometry).
Alias for unique_ptr to a vector of tp_ents (boundary geometry).
@par Multi-tasking data stream parameters
@note MAX_DATA_STREAMS is defined in AssocTyp_ch.h
data stream name
@par Multi-tasking data stream parameters
@note MAX_DATA_STREAMS is defined in AssocTyp_ch.h
data stream name
Equality operator.
The first instance to compare.
The second instance to compare.
True if the parameters are considered equivalent.
Fillet information.
lathe component boundary.
Lathe tool definition.
@}
for linked lists of material entities
LATHE TOOL
GENERAL HOLDER MENU CONFIGURATION
DRILLING TOOL MENU CONFIGURATION
GROOVING/PARTING INSERT MENU CONFIGURATION
THREADING INSERT MENU CONFIGURATION
GENERAL TURNING / BORING INSERT MENU CONFIGURATION
LATHE TOOL TYPE MENU CONFIGURATION
CONFIGURATION FOR DIMENSIONED BITMAP
CONFIGURATION INFO FOR A LIST VIEW OR DROPDOWN
@defgroup ltooldef_ch2 LIMITS
@{
@}
@defgroup ltooldef_ch7 DRILLING TYPES
@{
@}
@defgroup ltooldef_ch8 TAP TYPES
@{
@}
@defgroup ltooldef_ch9 TOOL COMPENSATION TYPES
@{
@}
FLOATING POINT EDIT BOX LIMITS, DEFAULTS
A lathe tool definition.
Lathe feed rate and units.
Custom lathe tool.
Generic tool holder.
All units always in inches!
Lathe insert/drilling tool definition.
All units always in inches!
Lathe drilling tool definition.
All units always in inches!
Grooving/Parting insert.
All units always in inches!
Threading insert.
All units always in inches!
General turning/boring insert.
All units always in inches!
CArchive read operator overload for the TlID class.
The archive.
The identifier.
The archive.
CArchive write operator overload for the TlID class.
The archive.
The identifier.
The adjusted archive.
Unique identifier.
Identifier for the empty tlid.
GUID casting operator.
CString casting operator.
Less-than comparison operator.
The other.
true if the first parameter is less than the second.
Greater-than comparison operator.
The other.
true if the first parameter is greater than to the second.
Inequality operator.
The other.
true if the parameters are not considered equivalent.
Equality operator.
The other.
true if the parameters are considered equivalent.
Inequality operator.
The other.
true if the parameters are not considered equivalent.
Equality operator.
The other.
true if the parameters are considered equivalent.
Assignment guid operator.
Unique identifier.
A shallow copy of this object.
Assignment string operator.
Unique identifier for the string.
A shallow copy of this object.
Convert this object into a string representation.
This object as a CString.
Parameterized blob constructor.
The BLOB.
The blobsize.
Parameterized byte guid constructor.
Unique identifier.
Parameterized string constructor.
Unique identifier for the string.
Parameterized string constructor.
Unique identifier for the string.
Default constructor.
Class representing a tool identifier in the form of a GUID (Globally unique identifier)
Values that represent custom coolant positions.
Values that represent custom coolant states.
Values that represent standard coolant statuses.
Values that represent tool orientation states.
Values that represent holder tool types.
Values that represent insert materials.
Values that represent coolant approach forces.
Values that represent coolant approach outputs.
Values that represent coolant approach types.
Values that represent component types.
Values that represent turn holder types.
Values that represent 3D Tool Assembly types.
Values that represent spindle speed units.
Values that represent tool library feed speed units.
Values that represent tool library active turrets.
Values that represent tool library active spindles.
Values that represent tool compensation positions states.
Values that represent tool library compensation types.
Defined methods for calculating the profile from the 3D model.
Values that represent the insert definition.
Values that represent the handedness of a tool or tool item.
Values that represent tool graphics file formats.
Values that represent the different Thread Shapes.
Values that represent the different shank types on tools.
Values that represent the different tool types that Mastercam supports.
Enumeration representing the Holder Lower Connection Type.
Helix type for router tools
Enumeration for spindle directions.
Enumeration representing the Tool Display Type
Enumeration that represent TlCornerType.
Enumeration for source of cut params.
Enumeration for cut quality.
Enumeration for radius types
Enumeration for different hardness scales.
Enumeration representing the different material ISO Group Values.
Enumeration for different material groups.
Values that represent the different Lathe Live Center taper styles.
Values that represent the different Lathe Live Center point styles.
@defgroup assocvar_ch26 tool radius types
@{
@}
@defgroup assocvar_ch27 canned cycle types
@{
@}
@defgroup assocvar_ch3 mill cutter capabilities
@{
@}
@defgroup ltooldef_ch3 LATHE TOOL TYPES
@{
@}
@defgroup ltooldef_ch4 CUSTOM GEOMETRY TOOL TYPES
@{
@}
@defgroup ltooldef_ch5 THREAD INSERT TYPES
@{
@}
@defgroup ltooldef_ch6 THREAD TYPES
@{
@}
Enumeration representing the Holder Upper Connection Type. Enumeration representing the Holder Upper Connection Type.
Declares the TlLatheDefinition type and its shared_ptr/unique_ptr aliases.
A class representing a lathe tool definition.
A class representing a lathe tool definition.
Declares the TlCuttingConfigurationGrooving type and its shared_ptr/unique_ptr aliases.
A grooving cutting configuration.
A grooving cutting configuration.
Declares the TlCuttingConfigurationThreading type and its shared_ptr/unique_ptr aliases.
A threading cutting configuration.
A threading cutting configuration.
Declares the TlCuttingConfigurationTurningBoring type and its shared_ptr/unique_ptr aliases.
A turning or boring cutting configuration.
A turning or boring cutting configuration.
Declares the TlCuttingConfiguration type and its shared_ptr/unique_ptr aliases.
A tool cutting configuration.
A tool cutting configuration.
Declares the TlAssemblyConfiguration type and its shared_ptr/unique_ptr aliases.
A tool assembly configuration.
A tool assembly configuration.
Declares the TlAssemblyComponentTree type and its shared_ptr/unique_ptr aliases.
Class representing a tree of assembly components.
Class representing a tree of assembly components.
Declares the TlAssemblyAdaptiveItem type and its shared_ptr/unique_ptr aliases.
Class representing an adaptive item that is part of a tool or holder assembly.
Class representing an adaptive item that is part of a tool or holder assembly.
Declares the TlAssemblyTurnHolder type and its shared_ptr/unique_ptr aliases.
Class representing a turn holder that is part of a tool assembly.
Class representing a turn holder that is part of a tool assembly.
Declares the TlAssemblyInsert type and its shared_ptr/unique_ptr aliases.
Class representing an insert that is part of a tool assembly.
Class representing an insert that is part of a tool assembly.
Declares the TlAssemblyComponent type and its shared_ptr/unique_ptr aliases.
Prototype class defining parameterized information on a tool assembly component.
Prototype class defining parameterized information on a tool assembly component.
Declares the TlToolAssemblyLatheDefView type and its shared_ptr/unique_ptr aliases.
A specific assembly component view of a TlToolAssembly instance.
Declares the TlToolAssemblyLatheDefView type and its shared_ptr/unique_ptr aliases.
A lathe definition view of a TlToolAssembly instance.
Declares the TlHolderAssembly type and its shared_ptr/unique_ptr aliases.
Class representing an assembly of adapters, extensions, and holders.
Class representing an assembly of adapters, extensions, and holders.
Declares the TlToolAssembly type and its shared_ptr/unique_ptr aliases.
Prototype class describing an assembly of tool components.
Prototype class describing an assembly of tool components.
Declares the TlAdaptiveItem type and its shared_ptr/unique_ptr aliases.
The TlAdaptiveItem class for adapters and extensions.
The TlAdaptiveItem class for adapters and extensions.
Declares the TlTurnHolder type and its shared_ptr/unique_ptr aliases.
A basic turn holder.
A basic turn holder.
Declares the TlBoundaryGenerationParams type and its shared_ptr/unique_ptr aliases.
Class defining boundary generation parameters to calculate cut and no-cut boundaries from a 3D Tool model.
Declares the TlConnectionMap type and its shared_ptr/unique_ptr aliases.
Defines an ID referencable map of connections.
Declares the TlConnection type and its shared_ptr/unique_ptr aliases.
A connection between tool components.
Declares the TlGraphicsFileCollection type and its shared_ptr/unique_ptr aliases.
Class representing a collection of tool graphics files.
Declares the TlGraphicsFile type and its shared_ptr/unique_ptr aliases.
Class representing a tool graphics file in memory.
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.
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.
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.
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.
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.
Class representing a tool manufacturer.
Declares the TlOpType type and its shared_ptr/unique_ptr aliases.
Class representing a custom user-defined operation type.
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.
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.
Class defining Drilling Tool Operation Parameters.
Declares the TlMillingOpParams type and its shared_ptr/unique_ptr aliases.
Class defining Milling Tool Operation Parameters.
Class defining Milling Tool Operation Parameters.
Declares the TlOpParams type and its shared_ptr/unique_ptr aliases.
Class defining Tool Operation Parameters.
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.
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.
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.
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.
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.
Class representing a Lathe Live Center.
Declares the TlHolderLatheTurning type and its shared_ptr/unique_ptr aliases.
Tl holder lathe turning.
Tl holder lathe turning.
Declares the TlHolderLatheThreading type and its shared_ptr/unique_ptr aliases.
Tl holder lathe threading class.
Tl holder lathe threading class.
Declares the TlHolderLatheGrooving type and its shared_ptr/unique_ptr aliases.
Tl holder lathe grooving class.
Tl holder lathe grooving class.
Declares the TlHolderLatheDrill type and its shared_ptr/unique_ptr aliases.
Tl holder lathe drill class.
Tl holder lathe drill class.
Declares the TlHolderLatheBoring type and its shared_ptr/unique_ptr aliases.
Tl holder lathe boring class.
Tl holder lathe boring class.
Declares the TlHolderLathe type and its shared_ptr/unique_ptr aliases.
Tl holder lathe class.
Tl holder lathe class.
Declares the TlInsertTurningBoring type and its shared_ptr/unique_ptr aliases.
Tl insert turning boring class.
Tl insert turning boring class.
Declares the TlInsertThreading type and its shared_ptr/unique_ptr aliases.
Tl insert threading class.
Tl insert threading class.
Declares the TlInsertLatheDrill type and its shared_ptr/unique_ptr aliases.
Tl insert lathe drill class.
Tl insert lathe drill class.
Declares the TlInsertGrooving type and its shared_ptr/unique_ptr aliases.
Tl insert grooving class.
Tl insert grooving class.
Declares the TlInsert type and its shared_ptr/unique_ptr aliases.
Base class for insert representation
Base class for insert representation
Declares the TlCoolant type and its shared_ptr/unique_ptr aliases.
Class representing a collection of tool coolant settings.
Class representing a collection of tool coolant settings.
Declares the TlCutParam type and its shared_ptr/unique_ptr aliases.
Class representing a cutting parameter.
Class representing a cutting parameter.
Declares the TlToolType type and its shared_ptr/unique_ptr aliases.
Class representing a custom user-defined tool type.
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.
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.
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.
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.
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.
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.
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.
Class representing barrel mill tools.
Declares the TlToolFeedMill type and its shared_ptr/unique_ptr aliases.
Class representing high feed milling tools
Class representing high feed milling tools
Declares the TlToolThreading type and its shared_ptr/unique_ptr aliases.
Class representing tools that have threading characteristics.
Class representing tools that have threading characteristics.
Declares the TlToolReamer type and its shared_ptr/unique_ptr aliases.
Class representing reamer tools.
Class representing reamer tools.
Declares the TlToolLatheCustom type and its shared_ptr/unique_ptr aliases.
Class representing custom lathe tools.
Class representing custom lathe tools.
Declares the TlToolLatheISO type and its shared_ptr/unique_ptr aliases.
Class representing isometric lathe tools.
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.
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.
Class represnting tool types that contain similar end milling type parameters.
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.
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.
Class representing center drill tools.
Declares the TlToolCounterBore type and its shared_ptr/unique_ptr aliases.
Class representing counter bore tools.
Class representing counter bore tools.
Declares the TlToolBoring type and its shared_ptr/unique_ptr aliases.
Class representing fine boring tools.
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.
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.
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.
Base class for all tool class objects.
Base class for all tool class objects.
Declares the ILToolDrillCutParams type and its shared_ptr/unique_ptr aliases.
An interface representing 3D lathe tool cutting parameters.
Declares the ILToolTurnBoreCutParams type and its shared_ptr/unique_ptr aliases.
An interface representing 3D lathe tool cutting parameters.
Declares the ILToolThreadCutParams type and its shared_ptr/unique_ptr aliases.
An interface representing 3D lathe tool cutting parameters.
Declares the ILToolGrooveCutParams type and its shared_ptr/unique_ptr aliases.
An interface representing 3D lathe tool cutting parameters.
Declares the ILToolCutParams type and its shared_ptr/unique_ptr aliases.
An interface representing 3D lathe tool cutting parameters.
Declares the IMTool type and its shared_ptr/unique_ptr aliases.
A mill tool interface.
Declares the I3dLTool type and its shared_ptr/unique_ptr aliases.
A 3d Lathe Tool interface.
Declares the ILTool type and its shared_ptr/unique_ptr aliases.
A lathe tool interface.
Declares the ITool type and its shared_ptr/unique_ptr aliases.
A tool interface.
A tool interface.
Defines an alias representing A constant iterator through a TlIDList.
Defines an alias representing a vector of type TlID.
POINTER TO MEMFILESTRUCT STRUCTURE
POINTER TO MEMFILESTRUCT STRUCTURE
MEMORY FILE BUFFER INFORMATION
MEMORY FILE BUFFER INFORMATION
DISK FILE INFORMATION
DISK FILE INFORMATION
WIN32 FILE INFORMATION
WIN32 FILE INFORMATION
ent_list_idn memory pointer info
setup and stock definition.
Position of the cylinder origin with respect to the cylinder shape.
This value must be a single byte to fit in as a replacement in the group structure.
Position of the rectangle origin with respect to the rectangle shape.
Note that the face names in the value names are labeled as viewed in 3d space in Mastercam with corresponding plane names,
not with respect to any static image used anywhere in the UI.
Origin corner for stock setup box
safety zones.
mc7 associative file header definition.
Wire change at point header.
Wire power set settings.
Wire power set pass settings.
A draw entity (Wire only).
A draw arc (Wire only).
A draw line (Wire only).
A draw point (Wire only).
Miscellaneous set data.
Miscellaneous pass set data.
wire new power set parameters.
wire new power pass parameters.
wire Agie parameters.
Positions (coordinates + method of getting there) for all axes
Axis coordinate
Axis coordinate types
The next 2 members are used for axis combination reference POINTS and home position only.
Single value to store group class and type for a set of component group parameters
The value is represented as: (100000 x group class) + group type.
Machine component unique identifier
use coolant to control submerged wire
use event list to activate coolant
use coolant commands in post-processor (provided for backward compatibility)
1st 'coolant off' command shuts off ALL coolant commands on the machine
coolant button text for tool page
'coolant off' interface display text
'coolant on' interface display text
'base' coolant interface display text
Coolant.
An operation events coolant.
@defgroup assocvar_ch40 tool types
@{
@}
MT work type
MT prototype version
material definition.
lathe specific material specs.
@defgroup material_structures Material Structures
@{
mill specific material specs.
Art Associative Entry.
Art Associative Entry.
@}
profile entity type
@}
profile entity type
Database List Entity
polygonal mesh entity as it appears in a file (difference is data_index).
polygonal_mesh (enhanced file_ent with persistant DB storage, smart memory usage, masking, selection,
etc.)
file entity (when e.id = FILE_ID, data is in e.u.f)
Bitmap type.
Description type.
File Lock History Type.
File Lock History Structure.
File Lock Type.
History Type.
A history structure.
Version Header.
Relative density (used in NCS files only)
structure for dimensions.
Union padding for v8 types.
Dimension parameters.
structure for tangent dimensions.
structure for linear dimensions.
structure for point dimensions.
structure for ordinate dimensions.
structure for circular dimensions (rad/dia)
structure for angular dimensions.
structure for linear dimensions.
structure for notes.
structure for dimension text.
structure for leaders and witness lines.
circular leader.
structure for standard non_assoc points.
A point.
A selected entity.
A hatch style.
Fonts Type.
Font style.
@note If a copious_data member is added between lathe_bdry_valid and pad1
and the new member is not supposed to be part of the copious_data
header, the define below must be changed to use the new member in place
of pad1.
Copius Data structure.
Data structure for font attributes.
The worksheets structure.
The level structure.
Structure to hold names of levels.
Visible levels.
Screen Information Type.
View Matrix Type.
Relief Information Type.
Art Bounding Box.
A CHAIN is a single chain or the start of a linked list of chains.
A chain ent entity.
Values that represent chain entity Identifiers.
A chain hash.
@defgroup chain_data_structures Chain Data Structures
@note END_OF_CHAIN is used only for manual sync (only at the end of
the first chain). Normally, the end of chain is determined from
next == NULL.
Information about the chain hash.
Cone definition structure that corresponds to Parasolid's cone structure.
To convert to Mastercam units one simply uses mastercamValue = PS2MC (parasolidValue)
for a value like the radius, or PS2MCPT3D (parasolidPoint, mastercamPoint) for point values. No
conversion is required for unit vectors like the axis and ref_direction or for an angular value.
Cylinder definition structure that corresponds to Parasolid's cylinder structure.
To convert to Mastercam units one simply uses mastercamValue = PS2MC (parasolidValue)
for a value like the radius, or PS2MCPT3D (parasolidPoint, mastercamPoint) for point values. No
conversion is required for unit vectors like the axis and ref_direction or for an angular value.
This corresponds to Parasolid's plane structure and to STEP's axis2_placement structure.
Solid Pocket detection Data.
Solid Drill detection Data.
Solid.
Solid data header for storing .x_t in partfile.
Surface Entity Type.
Trimmed Surface.
Offset Surface.
Plane.
Fillet.
Draft Surface.
Revolved Surface.
Loft Surface.
NURBS Surface.
piecewise polynomial surface.
A surface entity header.
composite curve.
Curve ON Surface.
@note If a spline member is added between pad and ent_ptr and the new
member is not supposed to be part of the spline header, the define
below must be changed to use the new member in place of ent_ptr.
NURBS Spline.
Parametric spline.
Entity Attribute Type.
EA Type.
misc. list of entities by ent_idn.
ent_idns for machine components and component groups in the database
Attribute structure.
@}
Attribute structure.
pocket boundary. This is the central data structure used by pocketing.
All boundaries and islands can be expressed in this structure. It
is a linked list.
@defgroup pock_data_structures Pocket Data Structures
@{
pointer to art data
pointer to art data
Homogeneous matrix.
pointer to art data.
Serializes this object's data to (or from) an archive.
Reference to archive.
Gets the runtime class ID of this object.
Class runtime ID.
Gets the class name of this object.
Class name.
Destructor.
Constructor.
Base object for classes requiring serialization support.
\ingroup GafBase
@{
Values that represent toolpath entity types
(for ent.u.tp.tp_id when ent.id == ASSOC_ID and ent.assoc_id == TP_ID).
Values that represent associative entity types
(for ent.assoc_id when ent.id == ASSOC_ID).
Convert a p_4d reference to a p_3d reference.
4D point to convert.
p_3d reference.
Convert a p_3d reference to a p_2d reference.
3D point to convert.
p_2d reference.
Convert a double pointer to a p_4d reference.
Double pointer to convert.
p_4d reference.
Convert a constant double pointer to a constant p_4d reference.
Double pointer to convert.
Constant p_4d reference.
Convert a double pointer to a p_3d reference.
Double pointer to convert.
p_3d reference.
Convert a constant double pointer to a constant p_3d reference.
Double pointer to convert.
Constant p_3d reference.
Convert a double pointer to a p_2d reference.
Double pointer to convert.
p_2d reference.
Convert a constant double pointer to a constant p_2d reference.
Double pointer to convert.
Constant p_2d reference.
Inequality operator overload for 4D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are not equal withing MTOL, false otherwise.
Equality operator overload for 4D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are equal withing MTOL, false otherwise.
Inequality operator overload for 3D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are not equal withing MTOL, false otherwise.
Equality operator overload for 3D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are equal withing MTOL, false otherwise.
Inequality operator overload for 2D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are not equal withing MTOL, false otherwise.
Equality operator overload for 2D point.
The comparison is done using the tolerance MTOL. Call Equal to compare two points
using a caller specified tolerance.
First point to compare.
Second point to compare.
True if the points are equal withing MTOL, false otherwise.
Computes the cross product of two 3D "vectors".
First vector.
Second vector.
Cross product.
Computes the cross product of two 2D "vectors".
First vector.
Second vector.
Cross product.
Computes the dot product of two 4D "vectors".
First vector.
Second vector.
Dot product.
Computes the dot product of two 3D "vectors".
First vector.
Second vector.
Dot product.
Computes the dot product of two 2D "vectors".
First vector.
Second vector.
Dot product.
Computes the distance squared between two 4D points.
First point.
Second point.
Distance squared.
Computes the distance squared between two 3D points.
First point.
Second point.
Distance squared.
Computes the distance squared between two 2D points.
First point.
Second point.
Distance squared.
Computes the distance between two 4D points.
First point.
Second point.
Distance.
Computes the distance between two 3D points.
First point.
Second point.
Distance.
@}
Computes the distance between two 2D points. First pnt. Second pnt. Distance.
3D line, point or arc
@}
Defines an alias representing the matrix 44.
Transformation matrix
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
4x3 matrix.
Constructor.
row 0 column 0.
row 0 column 1.
row 0 column 2.
row 1 column 0.
row 1 column 1.
row 1 column 2.
row 2 column 0.
row 2 column 1.
row 2 column 2.
Constructor.
X axis (row 0).
Y axis (row 1).
Z axis (row 2).
Constructor.
Math Library-style matrix to copy.
Constructor.
Matrix to copy.
Default constructor.
3x3 matrix (initialized).
By default, the matrix is initialized to the identity matrix.
Transposes this matrix.
Reference to this matrix.
Returns a matrix that is the transpose of this matrix.
Transposed matrix.
Checks if this object is the identity matrix.
True if identity matrix, false if not.
Sets this object to the identity matrix.
Array indexer operator overload.
The index.
The indexed value.
Array indexer operator overload.
The index.
The indexed value.
Operator (Cnc::Math::Matrix33) overload.
This object converted to a Math Library-style matrix.
Assignment operator overload.
Math Library-style matrix to copy.
A reference to this object.
@}
@defgroup matrix_types Matrix Types
@{
3x3 matrix.
2D line, point or arc
3D Arc
2D Arc
3D Line
2D Line
Assignment operator overload.
Point to copy.
A reference to this object.
Constructor.
3D point.
w value.
Constructor.
X/Y/Z/W values.
Constructor.
X value.
Y value.
Z value.
W value.
Constructor.
Math Library-style vector to copy.
Constructor.
Point to copy.
Default constructor.
4D point (initialized).
By default, the point is initialized to (0., 0., 0., 0.).
Multiplication operator overload for "scale * p_4d".
Value to multiply by.
4D point to scale.
A point which contains the result of the multiplication.
Gets a normalized (unitized) copy of this "vector".
Normalized "vector".
Normalizes (unitizes) this "vector".
A reference to this "vector".
Gets the length squared of this "vector".
Vector length squared.
Gets the length of this "vector".
Vector length.
Division assignment operator overload.
There is no check to insure "scale" is not zero.
Value to divide this point by.
A reference to this point.
Division operator overload.
There is no check to insure "scale" is not zero.
Value to divide by.
A point which contains the result of the division.
Multiplication assignment operator overload.
Value to multiply this point by.
A reference to this point.
Multiplication operator overload.
Value to multiply by.
A point which contains the result of the multiplication.
Subtraction assignment operator overload.
Point to subtract from this point.
A reference to this point.
Subtraction operator overload.
Point to subtract.
A point which contains the result of the subtraction.
Unary minus operator overload.
A point which contains this point negated.
Addition assignment operator overload.
Point to add to this point.
A reference to this point.
Addition operator overload.
Point to add.
A point which contains the result of the addition.
Less than operator overload.
Point to compare against.
True if this point is less than specified point, false otherwise.
Gets a double "array" pointer to this object.
Double pointer to this object.
Gets a double "array" pointer to this object.
Double pointer to this object.
Converts this object to a 3D point.
3D point.
Sets the X/Y/Z components of this object to the specified values.
3D point.
Sets this object to the specified values.
3D point.
W value.
Sets this object to the specified values.
X/Y/Z/W values.
Sets this object to the specified values.
X value.
Y value.
Z value.
W value.
Sets this object to (0., 0., 0., 0.).
Array indexer operator overload.
The index.
The indexed value.
Array indexer operator overload.
The index.
The indexed value.
Operator (Cnc::Math::Vector4D) overload.
This object converted to a math.
Assignment operator overload.
Point to copy.
A reference to this object.
4D point.
Assignment operator overload.
Point to copy.
A reference to this object.
Constructor.
2D point.
Z value.
Constructor.
X/Y values.
Z value.
Constructor.
X/Y/Z values.
Constructor.
X value.
Y value.
Z value.
Constructor.
Math Library-style vector to copy.
Constructor.
Point to copy.
Default constructor.
3D point (initialized).
By default, the point is initialized to (0., 0., 0.).
Multiplication operator overload for "scale * p_3d".
Value to multiply by.
3D point to scale.
A point which contains the result of the multiplication.
Gets a normalized (unitized) copy of this "vector".
Normalized "vector".
Normalizes (unitizes) this "vector".
A reference to this "vector".
Gets the length squared of this "vector".
Vector length squared.
Gets the length of this "vector".
Vector length.
Division assignment operator overload.
There is no check to insure "scale" is not zero.
Value to divide this point by.
A reference to this point.
Division operator overload.
There is no check to insure "scale" is not zero.
Value to divide by.
A point which contains the result of the division.
Multiplication assignment operator overload.
Value to multiply this point by.
A reference to this point.
Multiplication operator overload.
Value to multiply by.
A point which contains the result of the multiplication.
Subtraction assignment operator overload.
Point to subtract from this point.
A reference to this point.
Subtraction operator overload.
Point to subtract.
A point which contains the result of the subtraction.
Unary minus operator overload.
A point which contains this point negated.
Addition assignment operator overload.
Point to add to this point.
A reference to this point.
Addition operator overload.
Point to add.
A point which contains the result of the addition.
Less than operator overload.
Point to compare against.
True if this point is less than specified point, false otherwise.
Gets a double "array" pointer to this object.
Double pointer to this object.
Gets a double "array" pointer to this object.
Double pointer to this object.
Converts this object to a 2D point.
2D point.
Sets the X/Y components of this object to the specified values.
X/Y value.
Sets the X/Y components of this object to the specified values.
X value.
Y value.
Sets the X/Y components of this object to the specified values.
3D point.
Sets the X/Y components of this object to the specified values.
2D point.
Sets this object to the specified values.
2D point.
Z value.
Sets this object to the specified values.
X/Y values.
Z value.
Sets this object to the specified values.
X/Y/Z value.
Sets this object to the specified values.
X value.
Y value.
Z value.
Sets this object to (0., 0., 0.).
Array indexer operator overload.
The index.
The indexed value.
Array indexer operator overload.
The index.
The indexed value.
Operator (Cnc::Math::Vector3D) overload.
This object converted to a math.
Assignment operator overload.
Point to copy.
A reference to this object.
Assignment operator overload.
Point to copy.
A reference to this object.
Constructor.
X/Y values.
Constructor.
X value.
Y value.
Constructor.
Math Library-style vector to copy.
Constructor.
Point to copy.
Default constructor.
2D point (initialized).
By default, the point is initialized to (0., 0.).
Multiplication operator overload for "scale * p_2d".
Value to multiply by.
2D point to scale.
A point which contains the result of the multiplication.
Gets a normalized (unitized) copy of this "vector".
Normalized "vector".
Normalizes (unitizes) this "vector".
A reference to this "vector".
Gets the length squared of this "vector".
Vector length squared.
Gets the length of this "vector".
Vector length.
Division assignment operator overload.
There is no check to insure "scale" is not zero.
Value to divide this point by.
A reference to this point.
Division operator overload.
There is no check to insure "scale" is not zero.
Value to divide by.
A point which contains the result of the division.
Multiplication assignment operator overload.
Value to multiply this point by.
A reference to this point.
Multiplication operator overload.
Value to multiply by.
A point which contains the result of the multiplication.
Subtraction assignment operator overload.
Point to subtract from this point.
A reference to this point.
Subtraction operator overload.
Point to subtract.
A point which contains the result of the subtraction.
Unary minus operator overload.
A point which contains this point negated.
Addition assignment operator overload.
Point to add to this point.
A reference to this point.
Addition operator overload.
Point to add.
A point which contains the result of the addition.
Less than operator overload.
Point to compare against.
True if this point is less than specified point, false otherwise.
Gets a double "array" pointer to this object.
Double pointer to this object.
Gets a double "array" pointer to this object.
Double pointer to this object.
Converts this object to a 3D point.
3D point.
Sets this object to the specified values.
X/Y values.
Sets this object to the specified values.
X value.
Y value.
Sets this object to (0., 0.).
Array indexer operator overload.
The index.
The indexed value.
Array indexer operator overload.
The index.
The indexed value.
Operator (Cnc::Math::Vector2D) overload.
This object converted to a math.
Assignment operator overload.
Point to copy.
A reference to this object.
2D point.
@defgroup Points_Lines_Arcs Point, Line, and Arc Types
@{
3D point.
@defgroup dbvars_ch2 Entity IDs
@{
@}
@defgroup Mins_maxs_tols Min's, Max's, and Tolerances
@{
@}
@defgroup PI_and_Angles PI and Angles
@{
@}
@defgroup Points_Lines_Arcs Point, Line, and Arc Types
@{
@}
@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.