ToolLibrary Object

Derived from: Base Object
Defined in namespace "adsk::cam" and the header file is <Cam/Tools/ToolLibrary.h>

Description

ToolLibrary represents a collection of Tool objects.

Methods

Name Description
add Inserts a Tool at the end of the ToolLibrary.
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
createEmpty Creates an empty ToolLibrary.
createFromJson Creates a ToolLibrary by given JSON-string. Raises an error if the given JSON is invalid.
createQuery Creates a new ToolQuery that is used to query the library for tools matching the query.
item Get Tool by index in ToolLibrary.
remove Remove Tool by index from ToolLibrary.
toJson Generate and return JSON string that contains all tools of that list.

Properties

Name Description
count The number of tools in the ToolLibrary.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

DocumentToolLibrary.createEmpty, DocumentToolLibrary.createFromJson, ToolLibraries.toolLibraryAtURL, ToolLibrary.createEmpty, ToolLibrary.createFromJson, ToolQueryResult.toolLibrary

Derived Classes

DocumentToolLibrary

Samples

Name Description
Hole and Pocket Recognition API Sample

This sample script demonstrates three different methods for feature recognition: one for holes and two for pockets.

The script starts by creating a simple component which is then used to demonstrate the three methods. After the features are recognised they are coloured and milling and drilling operations are created for each feature.

RecognizedHoleGroup returns a list of BRepFaces that can be used as selections for the drilling operation. RecognizedPocket and PocketRecognitionSelection do not return BRepFaces, and their output needs additional processing before the output can be used for creating machining operations.

The sample script demonstrates a couple of different methods, including finding the pocket BRepFaces and creating sketches from the recognized pockets.

Manufacturing Workflow API Sample Manufacturing Workflow API Sample

This sample script starts by creating a simple component which is then used to describe a milling workflow. It creates a setup, a few operations, pick some tools from a Fusion sample tool library using loops and queries and ends up post-processing the operations out using an NC Program.

Version

Introduced in version April 2023