Tool¶

Methods:

The Tool class represents a tracked tool.

Public Functions

Tool()

Constructs a Tool object.

Tool frontTool = frame.tools().frontmost();
Tool firstToolInList = frame.tools().get(0);

Tool(Pointable arg0)

If the specified Pointable object represents a tool, creates a copy of it as a Tool object; otherwise, creates an invalid Tool object.

if (pointable.isTool()) {
    Tool toolFromPointable = new Tool(pointable);
}

String toString()

A string containing a brief, human readable description of the Tool object.

Return

A description of the Tool object as a string.

Public Static Functions

Tool invalid()

Returns an invalid Tool object.

if (!tool.equals(Tool.invalid())) {
    //Handle valid tool data
}

Return

The invalid Tool instance.