Tool - Revision history

WikiSysop: /* .ToolType */

2024-11-16T17:12:51Z

.ToolType

← Older revision		Revision as of 11:12, 16 November 2024
Line 123:		Line 123:
	:::''Tool.END_MILL''		:::''Tool.END_MILL''
	:::''Tool.RADIUSED_END_MILL''		:::''Tool.RADIUSED_END_MILL''
	:::''Tool.~~VBIT~~''		:::''Tool.VBit_Angle''
	:::''Tool.ENGRAVING''		:::''Tool.ENGRAVING''
	:::''Tool.RADIUSED_ENGRAVING''		:::''Tool.RADIUSED_ENGRAVING''
Line 130:		Line 130:
	:::''Tool.DIAMOND_DRAG''		:::''Tool.DIAMOND_DRAG''
	:::''Tool.RADIUSED_FLAT_ENGRAVING''		:::''Tool.RADIUSED_FLAT_ENGRAVING''



	===.ToolTypeText===		===.ToolTypeText===

WikiSysop at 16:57, 16 November 2024

2024-11-16T16:57:17Z

← Older revision		Revision as of 10:57, 16 November 2024
Line 11:		Line 11:
	:::''Tool.BALL_NOSE''		:::''Tool.BALL_NOSE''
	:::''Tool.END_MILL''		:::''Tool.END_MILL''
	:::''Tool.~~VBIT~~''		:::''Tool.VBit_angle''
	:::''Tool.THROUGH_DRILL''		:::''Tool.THROUGH_DRILL''

WikiSysop: /* :IsCompatibleFeedRates( Tool tool_to_check) */

2024-05-02T00:15:59Z

:IsCompatibleFeedRates( Tool tool_to_check)

← Older revision		Revision as of 18:15, 1 May 2024
Line 172:		Line 172:

	===:IsCompatibleFeedRates( Tool tool_to_check)===		===:IsCompatibleFeedRates( Tool tool_to_check)===
	'''Returns:''' (bool) true if this tool has same feed, plunge and spindles speeds as passed tool. Does not check geometry or cut depths (see: IsCompatibleTool and :IsCompatibleCutDepthss)		'''Returns:''' (bool) true if this tool has same feed, plunge and spindles speeds as passed tool. Does not check geometry or cut depths (see: IsCompatibleTool and :IsCompatibleCutDepthss)

	::''tool_to_check (Tool) tool we check for compatibility''		::''tool_to_check (Tool) tool we check for compatibility''


	===:IsCompatibleTool( Tool tool_to_check)===		===:IsCompatibleTool( Tool tool_to_check)===

WikiSysop: /* :ParameterExists( string parameter_name, utParameterType type) */

2024-05-02T00:15:39Z

:ParameterExists( string parameter_name, utParameterType type)

← Older revision		Revision as of 18:15, 1 May 2024
Line 217:		Line 217:

	===:ParameterExists( string parameter_name, utParameterType type)===		===:ParameterExists( string parameter_name, utParameterType type)===
	'''Returns:''' (bool) true if there is an existing parameter with passed name and type. (Aspire 4.015 or VCP 7.015 onwards only)		'''Returns:''' (bool) true if there is an existing parameter with passed name and type. (Aspire 4.015 or VCP 7.015 onwards only)

	::''parameter_name (string) the name of the parameter ''		::''parameter_name (string) the name of the parameter ''
	::''type (utParameterType) the type of parameter''		::''type (utParameterType) the type of parameter''


	===:SetBool(string parameter_name, bool value)===		===:SetBool(string parameter_name, bool value)===

WikiSysop: /* Methods */

2024-05-02T00:15:20Z

Methods

← Older revision		Revision as of 18:15, 1 May 2024
Line 178:		Line 178:

	===:IsCompatibleTool( Tool tool_to_check)===		===:IsCompatibleTool( Tool tool_to_check)===
	'''Returns:''' (bool) true if this tool is compatible (same type and geometry) as passed tool. Does not check cut depths or feed rates (see :IsCompatibleCutDepths and :IsCompatibleFeedRates for this data)		'''Returns:''' (bool) true if this tool is compatible (same type and geometry) as passed tool. Does not check cut depths or feed rates (see :IsCompatibleCutDepths and :IsCompatibleFeedRates for this data)

	::''tool_to_check (Tool) tool we check for compatibility''		::''tool_to_check (Tool) tool we check for compatibility''
Line 184:		Line 184:

	===:IsCompatibleCutDepths( Tool tool_to_check)===		===:IsCompatibleCutDepths( Tool tool_to_check)===
	'''Returns:''' (bool) true if this tool is has same cut depths as passed tool. Does not check geometry or feed rates		'''Returns:''' (bool) true if this tool is has same cut depths as passed tool. Does not check geometry or feed rates
	(see: IsCompatibleTool and:IsCompatibleFeedRates)		(see: IsCompatibleTool and:IsCompatibleFeedRates)

WikiSysop: /* Properties */

2024-05-02T00:14:43Z

Properties

← Older revision		Revision as of 18:14, 1 May 2024
Line 22:		Line 22:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(double) Clearance pass stepover for tool (VBits only)		'''Returns:'''(double) Clearance pass stepover for tool (VBits only)


Line 29:		Line 29:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(bool) flag indicating if tool is in mm or inches		'''Returns:'''(bool) flag indicating if tool is in mm or inches


Line 36:		Line 36:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(double) Feedrate for tool (see RateUnits for the units)		'''Returns:'''(double) Feedrate for tool (see RateUnits for the units)


Line 43:		Line 43:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (string) name of tool		'''Returns:''' (string) name of tool


Line 50:		Line 50:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (string) Notes field for tool . (Aspire 4.015 or VCP 7.015 onwards only)		'''Returns:''' (string) Notes field for tool . (Aspire 4.015 or VCP 7.015 onwards only)


Line 56:		Line 56:
	===.PlungeRate===		===.PlungeRate===
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Feed rate for tool		'''Returns:''' (double) Feed rate for tool

	Note: see RateUnits for the units		Note: see RateUnits for the units
Line 66:		Line 66:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) Feed rate units for tool.		'''Returns:''' (integer) Feed rate units for tool.

	::'''''Valid values are:'''''		::'''''Valid values are:'''''
	:::''Tool.MM_SEC''		:::''Tool.MM_SEC''
Line 88:		Line 89:
	===.SpindleSpeed===		===.SpindleSpeed===
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(integer) Spindle speed for tool		'''Returns:'''(integer) Spindle speed for tool


Line 96:		Line 97:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(double) Stepdown for tool		'''Returns:'''(double) Stepdown for tool


Line 103:		Line 104:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:'''(double) Stepover for tool		'''Returns:'''(double) Stepover for tool


Line 110:		Line 111:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (string) path to tool in tool database		'''Returns:''' (string) path to tool in tool database
	Note: not including tool name		Note: not including tool name

Line 118:		Line 119:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (integer) an integer indicating the type of the tool values are:		'''Returns:''' (integer) an integer indicating the type of the tool values are:
	:::''Tool.BALL_NOSE''		:::''Tool.BALL_NOSE''
	:::''Tool.END_MILL''		:::''Tool.END_MILL''
Line 135:		Line 136:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (string) a string indicating the type of the tool		'''Returns:''' (string) a string indicating the type of the tool


Line 142:		Line 143:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Diameter of tool		'''Returns:''' (double) Diameter of tool


Line 149:		Line 150:
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) Tool number for tool		'''Returns:''' (integer) Tool number for tool

	===.ToolDBId ===		===.ToolDBId ===
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (integer) ToolDBId – The Id describing the location in the tool database		'''Returns:''' (integer) ToolDBId – The Id describing the location in the tool database

	===.VBit_Angle===		===.VBit_Angle===
	'''Interaction:''' Read and Write		'''Interaction:''' Read and Write

	'''Returns:''' (double) Included angle for VBit tools		'''Returns:''' (double) Included angle for VBit tools









	==Methods==		==Methods==

WikiSysop: /* :GetDouble( string parameter_name, double default_value,) */

2021-08-04T16:35:22Z

:GetDouble( string parameter_name, double default_value,)

← Older revision		Revision as of 10:35, 4 August 2021
Line 215:		Line 215:
	::''parameter_name (string) the name of the parameter''		::''parameter_name (string) the name of the parameter''
	::''default_value(double) the value which will be returned if there is no existing value stored''		::''default_value(double) the value which will be returned if there is no existing value stored''

	~~::''parameter_name (string) the name of the parameter''~~
	~~::''default_value (double) the value which will be returned if there is no existing value stored~~

	===:GetInt( string parameter_name, integer default_value)===		===:GetInt( string parameter_name, integer default_value)===

WikiSysop: /* :GetDouble( string parameter_name, double default_value,) */

2021-08-04T16:35:03Z

:GetDouble( string parameter_name, double default_value,)

← Older revision		Revision as of 10:35, 4 August 2021
Line 216:		Line 216:
	::''default_value(double) the value which will be returned if there is no existing value stored''		::''default_value(double) the value which will be returned if there is no existing value stored''

			::''parameter_name (string) the name of the parameter''
			::''default_value (double) the value which will be returned if there is no existing value stored

	===:GetInt( string parameter_name, integer default_value)===		===:GetInt( string parameter_name, integer default_value)===

WikiSysop: /* .ToolNumber */

2021-08-04T16:27:45Z

.ToolNumber

← Older revision		Revision as of 10:27, 4 August 2021
Line 151:		Line 151:
	'''Returns:''' (integer) Tool number for tool		'''Returns:''' (integer) Tool number for tool

			===.ToolDBId ===
			'''Interaction:''' Read and Write

			'''Returns:''' (integer) ToolDBId – The Id describing the location in the tool database

	===.VBit_Angle===		===.VBit_Angle===

WikiSysop: /* Tool( string name, ToolType tool_type) */

2021-08-04T16:26:08Z

Tool( string name, ToolType tool_type)

← Older revision		Revision as of 10:26, 4 August 2021
Line 15:		Line 15:

	'''NOTE:''' ''If you change ANY parameters or properties on a tool retrieved from an EXISTING toolpath, you MUST call UpdateParameters() after you have finished editing tool properties to flush the changes through to the toolpath.''		'''NOTE:''' ''If you change ANY parameters or properties on a tool retrieved from an EXISTING toolpath, you MUST call UpdateParameters() after you have finished editing tool properties to flush the changes through to the toolpath.''



	==Properties==		==Properties==