Inherits ScriptObject.
Public Attributes | |
| Integer | number |
| The tool number. | |
| Integer | turret |
| The turret. | |
| Integer | diameterOffset |
| The diameter offset (used for milling). | |
| Integer | lengthOffset |
| The length offset (used for milling). | |
| Integer | compensationOffset |
| The compensation offset (used for turning). | |
| Boolean | manualToolChange |
| True if tool must be manually changed. | |
| Boolean | breakControl |
| True if break control is enabled. | |
| Boolean | liveTool |
| True if the tool is live - otherwise it is static. | |
| Integer | holderNumber |
| Number identifying the holder. | |
| Integer | spindleMode |
| The spindle mode. | |
| Number | spindleRPM |
| The spindle speed in RPM. Positive for clockwise direction. | |
| Number | rampingSpindleRPM |
| The spindle speed in RPM for ramping. Positive for clockwise direction. | |
| Number | surfaceSpeed |
| The surface speed (CSS). | |
| Number | maximumSpindleSpeed |
| The maximum spindle speed (RPM) when using surface speed (CSS). | |
| Integer | numberOfFlutes |
| The number of flutes. | |
| Number | threadPitch |
| The number of thread per unit of length. | |
| Integer | coolant |
| The coolant. | |
| Integer | material |
| The material. | |
| String | comment |
| Comment. | |
| String | vendor |
| The vendor. | |
| String | productId |
| The product id. | |
| Integer | unit |
| The unit. | |
| Integer | type |
| The tool type. | |
| Number | diameter |
| The diameter. | |
| Number | cornerRadius |
| The corner radius. | |
| Number | taperAngle |
| The taper angle. | |
| Number | fluteLength |
| The flute length. | |
| Number | shoulderLength |
| The shoulder length. | |
| Number | shaftDiameter |
| The shaft diameter. | |
| Number | bodyLength |
| The body length. | |
| Number | overallLength |
| The entire length of the tool. | |
| Shaft | shaft |
| The tool shaft. | |
| Number | holderTipDiameter |
| The holder tip diameter. | |
| Number | holderDiameter |
| The holder diameter. | |
| Number | holderLength |
| The holder length. | |
| Holder | holder |
| The tool holder. | |
| Number | boringBarOrientation |
| The boring bar orientation in radians. | |
| Number | inscribedCircleDiameter |
| The inscribed circle diameter for turning tool. | |
| Number | edgeLength |
| The edge length for turning tool. | |
| Number | noseRadius |
| The nose radius for turning tools. | |
| Number | reliefAngle |
| The relief angle in degrees. | |
| Number | thickness |
| The turning tool thickness;. | |
| Number | grooveWidth |
| The groove tool width. | |
| String | crossSection |
| The cross section type for turning tools. | |
| String | tolerance |
| The tolerance for turning tools. | |
| Number | pitch |
| The thread pitch for turning tools. | |
| String | hand |
| The holder hand. Left, Right, or Neutral. | |
| String | clamping |
| Clamping for turning tools. | |
| Number | jetDistance |
| The jet distance. More... | |
| Number | jetDiameter |
| The jet diameter. | |
| Number | kerfWidth |
| The kerf width. | |
| String | machineQualityControl |
| The machine quality control. | |
| Number | cutHeight |
| The cut height. | |
| Number | pierceHeight |
| The pierce height. | |
| Number | pressure |
| The pressure. | |
| Number | pierceTime |
| The pierce time. | |
| Number | abrasiveFlowRate |
| The abrasive flow rate. | |
| Number | piercePower |
| The pierce power. | |
| Number | cutPower |
| The cut power. | |
| String | assistGas |
| The assist gas. | |
A tool specification.
| Tool | ( | ) |
Constructs a tool.
| Number getAbrasiveFlowRate | ( | ) |
| String getAggregateId | ( | ) |
Returns the aggregate id.
| String getAssistGas | ( | ) |
| Number getBodyLength | ( | ) |
Returns the body length.
| Number getBoringBarOrientation | ( | ) |
Returns the boring bar orientation in radians.
| Boolean getBreakControl | ( | ) |
Returns true if break control is enabled.
| String getComment | ( | ) |
Returns the tool comment.
| Vector getCompensationDisplacement | ( | ) |
Returns the turning compensation displacement for the toolpath. The Z-coordinate is always 0.
| Integer getCompensationMode | ( | ) |
Returns the turning compensation mode.
The available modes are:
| Integer getCompensationOffset | ( | ) |
Returns the primary compensation offset for turning.
| Integer getCoolant | ( | ) |
Returns the coolant mode.
| Number getCornerRadius | ( | ) |
Returns the corner radius.
| Number getCutHeight | ( | ) |
| Number getCutPower | ( | ) |
Returns the cutter as a mesh.
| tolerance | The linearization tolerance. |
| String getCutterProfileAsSVGPath | ( | ) |
Returns the SVG profile of the cutter.
| String getDescription | ( | ) |
Returns the tool description.
| Number getDiameter | ( | ) |
Returns the cutter diameter.
| Integer getDiameterOffset | ( | ) |
Returns the diameter offset.
| BoundingBox getExtent | ( | Boolean | includeHolder | ) |
Returns the tool extent.
| includeHolder | Set to true to include the extent of the holder. |
| Number getFluteLength | ( | ) |
Returns the flute length.
| Holder getHolder | ( | ) |
Returns the holder.
Returns the holder as a mesh.
| tolerance | The linearization tolerance. |
| String getHolderComment | ( | ) |
Returns the holder comment.
| String getHolderDescription | ( | ) |
Returns the holder description.
| Number getHolderDiameter | ( | ) |
Returns the maximum holder diameter.
| Number getHolderLength | ( | ) |
Returns the total holder length.
| Integer getHolderNumber | ( | ) |
Returns the holder number.
| String getHolderProductId | ( | ) |
Returns the holder product id.
| String getHolderProfileAsSVGPath | ( | ) |
Returns the SVG profile of the holder.
| Number getHolderTipDiameter | ( | ) |
Returns the tip diameter of the holder.
| Integer getHolderType | ( | ) |
Returns the turning holder type.
The available types are:
| String getHolderVendor | ( | ) |
Returns the holder vendor.
| Integer getInsertType | ( | ) |
Returns the turning insert type.
The available types are:
| Number getJetDiameter | ( | ) |
| Number getJetDistance | ( | ) |
Deprecated (not used).
| Number getKerfWidth | ( | ) |
| Integer getLengthOffset | ( | ) |
Returns the length offset.
| String getMachineQualityControl | ( | ) |
When set to "manual" the programmed feedrates will be used, "automatic" will disable feedrate output and the machine control will handle the feedrates of the toolpaths. The post processor must support this setting for "automatic " to have any effect on the output.
| Boolean getManualToolChange | ( | ) |
Returns true if the tool must be manually changed.
| Integer getMaterial | ( | ) |
Returns the material.
| Number getMaximumSpindleSpeed | ( | ) |
Returns the maximum spindle speed (RPM) when using surface speed (CSS).
| Integer getNumber | ( | ) |
Returns the tool number.
| Integer getNumberOfFlutes | ( | ) |
Returns the number of flutes.
| Number getOverallLength | ( | ) |
Returns the entire length of the tool.
| Number getPierceHeight | ( | ) |
| Number getPiercePower | ( | ) |
| Number getPierceTime | ( | ) |
| Number getPressure | ( | ) |
| String getProductId | ( | ) |
Returns the tool product id.
| Number getRampingSpindleRPM | ( | ) |
Returns the ramping spindle speed in RPM (rotations per minute).
| Integer getSecondaryCompensationOffset | ( | ) |
Returns the secondary compensation offset for turning.
| Integer getSecondaryLengthOffset | ( | ) |
Returns the secondary length offset.
| Shaft getShaft | ( | ) |
Returns the shaft.
| Number getShaftDiameter | ( | ) |
Returns the shaft diameter.
| Number getShoulderLength | ( | ) |
Returns the shoulder length.
| Integer getSpindleMode | ( | ) |
Returns the spindle mode.
The available modes are:
| Number getSpindleRPM | ( | ) |
Returns the spindle speed in RPM (rotations per minute).
| Number getSurfaceSpeed | ( | ) |
Returns the surface speed (CSS).
| Number getTaperAngle | ( | ) |
Returns the taper angle in radians.
| Number getTappingFeedrate | ( | ) |
Returns the tapping feedrate as spindle RPM * thread pitch.
| Number getThreadPitch | ( | ) |
Returns the number of threads per unit of length.
| Number getTipDiameter | ( | ) |
Returns the tip diameter.
| String getToolId | ( | ) |
Returns the tool id.
Note: it is an internal (unique) id of the tool in a Fusion/Inventor document. For instance, when adding/creating a tool (not exist) in the document, a new id is created for the tool, which is added into the document's tool library.
| Integer getTurret | ( | ) |
Returns the turret for turning.
| Integer getType | ( | ) |
Returns the tool type.
The types are:
| Integer getUnit | ( | ) |
Returns the tool unit.
The available values are:
| String getVendor | ( | ) |
Returns the tool vendor.
| Boolean isClockwise | ( | ) |
Returns true if the spindle rotates in clockwise direction.
| Boolean isDrill | ( | ) |
Returns true if the tool is a drill.
| Boolean isJetTool | ( | ) |
Returns true if the tool is a jet tool.
| Boolean isLiveTool | ( | ) |
Returns true if the tool is live. Otherwise tool is static (ie. mounted without a spindle).
| Boolean isTurningTool | ( | ) |
Returns true if the tool is a turning tool.
| Number jetDistance |
The jet distance.