Role: This interface is used to work with ARCTagGroup.
The following code snippet can be used to obtain a Tag from a selected Product
Set ParentObject = CATIA.ActiveDocument.Selection.FindObject("CATIAProduct")
Set objTag = ParentObject.GetTechnologicalObject("Tag")
Methods
- Sub ComputeDistanceAlongSeam( iFirstTagIdx, iSecondTagIdx, oDistance)
-
Function to compute the distance along the seam between two ARC tags of the ARCTagGroup.
- Parameters:
-
- iFirstTagIdx
- the index of the first tag.
- iSecondTagIdx
- the index of the second tag.
- oDistance
- the computed distance along the seam.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetARCTagsList( oARCTagList)
-
Function to get all the ARC tags grouped by the ARCTagGroup.
- Parameters:
-
- oARCTagList
- the ARC tags list.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetNumARCTags( oSize)
-
Function to get the total number of ARC tags grouped by the ARCTagGroup.
- Parameters:
-
- oSize
- the total number of ARC tags grouped by the ARCTagGroup.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetTagGroup( oTagGroup)
-
Function to get the underlying basic TagGroup.
- Parameters:
-
- oTagGroup
- the underlying basic TagGroup.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetTagParam( iIdx, iParamName, oVal)
-
Function to get the value of a given ARC tag parameter. The concerned ARC tag's index should be given.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iParamName
- the name of the ARC tag parameter. Following ARC tag parameters can be set: "WireAngle", "FlareAngle", "RakeAngle", "WireRollAngle", "BaseTangentOffset", "WallTangentOffset", "ShiftDistance", "FlareLength", "StickOut", "TCPStickOut", "NearDistance"
- oVal
- the value of the ARC tag parameter.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateTag( iIdx, iAngle, iDirVector)
-
Function to rotate the ARC tag with the given index about the given direction vector.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iAngle
- the angle by which the ARC tag should be rotated about the given direction vector.
- iDirVector
- the direction vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateXTag( iIdx, iAngle)
-
Function to rotate the ARC tag with the given index about it's x-axis.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iAngle
- the angle by which the ARC tag should be rotated about it's x-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateYTag( iIdx, iAngle)
-
Function to rotate the ARC tag with the given index about it's y-axis.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iAngle
- the angle by which the ARC tag should be rotated about it's y-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateZTag( iIdx, iAngle)
-
Function to rotate the ARC tag with the given index about it's z-axis.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iAngle
- the angle by which the ARC tag should be rotated about it's z-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub SetTagParam( iIdx, iParamName, iVal)
-
Function to set the value of a given ARC tag parameter. The concerned ARC tag's index should be given.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iParamName
- the name of the ARC tag parameter. Following ARC tag parameters can be set: "WireAngle", "FlareAngle", "RakeAngle", "WireRollAngle", "BaseTangentOffset", "WallTangentOffset", "ShiftDistance", "FlareLength", "StickOut", "TCPStickOut", "NearDistance"
- iVal
- the value of the ARC tag parameter.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub TranslateTag( iIdx, iDistance, iDirVector)
-
Function to translate the ARC tag with the given index along the given direction vector.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iDistance
- the distance by which the ARC tag should be translated along the given direction vector.
- iDirVector
- the direction vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub TranslateTagAlongSeam( iIdx, iDistance)
-
Function to translate the ARC tag with the given index along the seam.
- Parameters:
-
- iIdx
- the index of the ARC tag in the ARCTagGroup.
- iDistance
- the distance by which the ARC tag should be translated along the seam.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .