MillingTrackpointBuilder Class¶
-
class
NXOpen.CAM.
MillingTrackpointBuilder
¶ Bases:
NXOpen.TaggedObject
Represents a Milling Trackpoint Builder
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
NumberOfTrackPoints | Returns the number of trackpoints |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Add | Add a new trackpoint, name maybe changed if not unique |
CalculateDistance | Calculate distance when defining tracking point only by the diameter |
Delete | Delete an existing trackpoint |
Get | Get the values of an existing trackpoint |
GetTrackPoint | Get a specific trackpoint |
Modify | Modify an existing trackpoint,name maybe changed if not unique |
MoveDown | Move down a trackpoint |
MoveUp | Move up a trackpoint |
Enumerations¶
MillingTrackpointBuilderTypes Enumeration | the definition enum |
Property Detail¶
Method Detail¶
Add¶
-
MillingTrackpointBuilder.
Add
¶ Overloaded method Add
Add(inputIndex, name, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Add(inputIndex, name, definitionType, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
-------------------------------------
Add a new trackpoint, name maybe changed if not unique
Signature
Add(inputIndex, name, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Parameters: - inputIndex (int) – the input index of new track point
- name (str) – the new created object name
- diameter (float) – the diameter
- distance (float) – the distance
- zOffset (float) – the zoffset
- zOffsetUsed (int) – the zoffset toggle
- adjust (int) – the adjust
- adjustUsed (int) – the adjust toggle
- cutcom (int) – the cutcom
- cutcomUsed (int) – the cutcom toggle
Returns: a tuple
Return type: A tuple consisting of (outputIndex, newName) outputIndex is a int. output actual index of new track point, if error happens, output will be -1 newName is a str. the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN
New in version NX6.0.0.
Deprecated since version NX10.0.0: Use new version with additional arguments instead.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Add a new track point, the input name will be changed if it is not unique.
Signature
Add(inputIndex, name, definitionType, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Parameters: - inputIndex (int) – the input index of new track point
- name (str) – the new created object name
- definitionType (int) – the definition type
- diameter (float) – the diameter
- distance (float) – the distance
- zOffset (float) – the zoffset
- zOffsetUsed (int) – the zoffset toggle
- adjust (int) – the adjust
- adjustUsed (int) – the adjust toggle
- cutcom (int) – the cutcom
- cutcomUsed (int) – the cutcom toggle
Returns: a tuple
Return type: A tuple consisting of (outputIndex, newName) outputIndex is a int. the actual index of the new track point, if there is error, output is -1 newName is a str. the final new object name,user should allocate memory for it first, most length is UGUI_MAX_NAME_LEN
New in version NX10.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
CalculateDistance¶
-
MillingTrackpointBuilder.
CalculateDistance
¶ Calculate distance when defining tracking point only by the diameter
Signature
CalculateDistance(definitionType)
Parameters: definitionType (int) – the definition type Returns: a tuple Return type: A tuple consisting of (distance, diameter) distance is a float. the distance diameter is a float. the diameter New in version NX10.0.0.
License requirements: cam_base (“CAM BASE”)
Delete¶
-
MillingTrackpointBuilder.
Delete
¶ Delete an existing trackpoint
Signature
Delete(index)
Parameters: index (int) – the index of deleted track point New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
Get¶
-
MillingTrackpointBuilder.
Get
¶ Get the values of an existing trackpoint
Signature
Get(pointTag)
Parameters: pointTag ( NXOpen.NXObject
) – the track pointReturns: a tuple Return type: A tuple consisting of (name, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed) name is a str. the name diameter is a float. the diameter distance is a float. the distance zOffset is a float. the zoffset zOffsetUsed is a int. the zoffset toggle adjust is a int. the adjust adjustUsed is a int. the adjust toggle cutcom is a int. the cutcom cutcomUsed is a int. the cutcom toggle New in version NX6.0.0.
Deprecated since version NX10.0.0: Use new version _tp with additional arguments instead.
License requirements: cam_base (“CAM BASE”)
GetTrackPoint¶
-
MillingTrackpointBuilder.
GetTrackPoint
¶ Overloaded method GetTrackPoint
GetTrackPoint(position)
GetTrackPoint(pointTag)
-------------------------------------
Get a specific trackpoint
Signature
GetTrackPoint(position)
Parameters: position (int) – the position of track point Returns: the track point Return type: NXOpen.NXObject
New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Get the values of an existing track point.
Signature
GetTrackPoint(pointTag)
Parameters: pointTag ( NXOpen.NXObject
) – the track pointReturns: a tuple Return type: A tuple consisting of (name, definitionType, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed) name is a str. the name definitionType is a int. the definition type diameter is a float. the diameter distance is a float. the distance zOffset is a float. the zoffset zOffsetUsed is a int. the zoffset toggle adjust is a int. the adjust adjustUsed is a int. the adjust toggle cutcom is a int. the cutcom cutcomUsed is a int. the cutcom toggle New in version NX10.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Modify¶
-
MillingTrackpointBuilder.
Modify
¶ Overloaded method Modify
Modify(index, name, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Modify(index, name, definitionType, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
-------------------------------------
Modify an existing trackpoint,name maybe changed if not unique
Signature
Modify(index, name, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Parameters: - index (int) – the index of modified track point
- name (str) – the object new name
- diameter (float) – the diameter
- distance (float) – the distance
- zOffset (float) – the zoffset
- zOffsetUsed (int) – the zoffset toggle
- adjust (int) – the adjust
- adjustUsed (int) – the adjust toggle
- cutcom (int) – the cutcom
- cutcomUsed (int) – the cutcom toggle
Returns: the final object name,user should allocate memory for it first,
most length is UGUI_MAX_NAME_LEN :rtype: str
New in version NX6.0.0.
Deprecated since version NX10.0.0: Use new version with additional arguments instead.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Modify an existing track point, the input name will be changed if it is not unique.
Signature
Modify(index, name, definitionType, diameter, distance, zOffset, zOffsetUsed, adjust, adjustUsed, cutcom, cutcomUsed)
Parameters: - index (int) – the index of modified track point
- name (str) – the object new name
- definitionType (int) – the definition type
- diameter (float) – the diameter
- distance (float) – the distance
- zOffset (float) – the zoffset
- zOffsetUsed (int) – the zoffset toggle
- adjust (int) – the adjust
- adjustUsed (int) – the adjust toggle
- cutcom (int) – the cutcom
- cutcomUsed (int) – the cutcom toggle
Returns: the final object name,user should allocate memory for it first,
most length is UGUI_MAX_NAME_LEN :rtype: str
New in version NX10.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------