def get_plane_axis_coord(self, i_coor_idx: int) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func GetPlaneAxisCoord(long iCoorIdx) As Length
|
| Retrieves the translation coordinates.
| Role: The translation coordinates are expressed with respect to the planar
| coordinate system related to the 2D planar wire from its default position.
| GetPlaneAxisCoord retrieves one coordinate at a time.
|
| Parameters:
|
| iCoorIdx
| The coordinate index
| Legal values
| : 1 for X and 2 for Y
|
| Returns:
| The coordinate value
:param int i_coor_idx:
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_develop.GetPlaneAxisCoord(i_coor_idx))
def tangency_objective(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property TangencyObjective() As Length (Read Only)
|
| Returns the Tangency Objective of the healing.
|
| Parameters:
|
| TangencyObjective
| Length parameter for retrieving the Tangency
| Objective.
|
| Example:
| This example retrieves the TangencyObjective of the healing of
| the HybShpHealing hybrid shape healing.
|
| Dim HybShpHealTangencyObjective As Length
| Set HybShpHealTangencyObjective = HybShpHealing.TangencyObjective
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_healing.TangencyObjective)
def offset2(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Offset2() As Length (Read Only)
|
| Returns the second offset parameter of the curve parameter
| object.
|
| Example:
|
| This example retrieves the second offset parameter
| of
| the hybShpCurvePar in offsetParm.
|
|
| Dim offsetParm As CATIALength
| offsetParm = hybShpCurvePar.Offset2
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_curve_par.Offset2)
def begin_offset(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property BeginOffset() As Length (Read Only)
|
| Role: To get_BeginOffset on the object. For surface extrude, if limit type
| is upto, this offset value is not used. In case of Volume Extrude, if the up-to
| element is specified, this will act as offset value from the upto
| element.
|
| Parameters:
|
| oExtrude
| return value for CATScript applications, with (IDLRETVAL) function
| type
|
| See also:
| Length
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_extrude.BeginOffset)
def start_param(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property StartParam() As Length (Read Only)
|
| Gets start parameter.
| Note: Used for law type = 1(Constant) ,2(Linear) and 3(SType)
|
| Parameters:
|
| StartParam
| Parameter This example retrieves in SParam the start parameter for
| the IntegratedLaw hybrid shape feature.
|
| Dim SParam
| Set SParam = IntegratedLaw.StartParam
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_integrated_law.StartParam)
def radius(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Radius() As Length (Read Only)
|
| Returns the circle radius.
|
| Parameters:
|
| Radius
| The circle radius, expressed as a
|
| Length literal. Succeeds only if DiameterMode is set to False.
|
|
| Example:
| This example retrieves in HybShpCircleRadius the radius of the HybShpCircle
| hybrid shape circle.
|
| Dim HybShpCircleRadius As Length
| HybShpCircleRadius = HybShpCircle.Radius
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_circle2_points_rad.Radius)
def merging_distance(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property MergingDistance() As Length (Read Only)
|
| Returns the Merging Distance of the healing.
|
| Parameters:
|
| MergingDistance
| Length parameter for retrieving the Merging
| Distance.
|
| Example:
| This example retrieves the MergingDistance of the healing of
| the HybShpHealing hybrid shape healing.
|
| Dim HybShpHealMergeDist As Length
| Set HybShpHealMergeDist = HybShpHealing.MergingDistance
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_healing.MergingDistance)
def get_radius(self, i_i: int) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func GetRadius(long iI) As Length
|
| Returns the radius value useful in some circular sweep
| types.
|
| Parameters:
|
| iI
| The radius value index (1: start value, 2: end value)
|
|
| Returns:
| The radius value
:param int i_i:
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_sweep_circle.GetRadius(i_i))
def thread_pitch(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property ThreadPitch() As Length (Read Only)
|
| Returns the hole thread pitch.
| This call is valid when the hole threading mode is : CATThreadedHoleThreading.
|
| Returns:
| oThreadPitch A Length object controlling the hole thread pitch (see
| Length for more information)
|
| Example:
| The following example returns in holeThreadPitch the thread pitch
| of hole firstHole:
|
| Set holeThreadPitch = firstHole.ThreadPitch
:return: Length
:rtype: Length
"""
return Length(self.hole.ThreadPitch)
def offset(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Offset() As Length (Read Only)
|
| Returns the distance to the reference point.
| This distance is a distance in a length unit, The distance can be null.In
| this case, the reference point is the curve end point defined using the
| Orientation parameter.
|
| Example:
|
| This example retrieves in oOffset the distance from the reference
| point
| on the supporting curve for the pointOnCurve hybrid shape
| object.
|
|
| Dim oOffset As CATIALength
| Set oOffset = pointOnCurve.Offset
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_point_on_curve.Offset)
def diameter(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Diameter() As Length (Read Only)
|
| Returns the hole diameter.
|
| Returns:
| oDiameter A Length object controlling the hole diameter (see Length for
| more information)
|
| Example:
| The following example returns in holeDiam the diameter of hole
| firstHole:
|
| Set holeDiam = firstHole.Diameter
:return: Length
:rtype: Length
"""
return Length(self.hole.Diameter)
def head_diameter(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property HeadDiameter() As Length (Read Only)
|
| Returns the hole head diameter.
| This call is valid when the hole type is : Counterbored or Counterdrilled.
|
| Returns:
| oHeadDiameter A Length object controlling the hole head diameter (see
| Length for more information)
|
| Example:
| The following example returns in holeHeadDiam the head diameter of
| hole firstHole:
|
| Set holeHeadDiam = firstHole.HeadDiameter
:return: Length
:rtype: Length
"""
return Length(self.hole.HeadDiameter)
def radius(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Radius() As Length (Read Only)
|
| Role: Get sphere radius.
|
| Parameters:
|
| oRadius
| Sphere radius return value for CATScript applications, with
| (IDLRETVAL) function type
|
| See also:
| Length
| See also:
| HybridShapeFactory
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_sphere.Radius)
def get_curvature_radius(self, i_pos: int) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func GetCurvatureRadius(long iPos) As Length
|
| Returns the curvature radius value for each point of the
| spline.
|
| Parameters:
|
| iPos
| The position of the point in the spline.
| Legal values: first position is 1. The position cannot be 0.
|
| oRadius
| The curvature radius value at this point
:param int i_pos:
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_spline.GetCurvatureRadius(i_pos))
def offset(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Offset() As Length (Read Only)
|
| Role: To get_Offset on the object.
|
| Parameters:
|
| oOffset
| offset value return value for CATScript applications, with
| (IDLRETVAL) function type
|
| See also:
| Length
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_rolling_offset.Offset)
def imposed_vertex_radius(self, i_imposed_vertex: Reference) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func ImposedVertexRadius(Reference iImposedVertex) As
| Length
|
| Returns the fillet radius on an imposed vertex.
|
| Parameters:
|
| iImposedVertex
| The vertex where to retrieve the fillet radius
|
| Returns:
| The fillet radius
| Example:
| The following example returns in radius the fillet radius of the
| variable radius edge fillet firstVarEdgeFillet at the vertex
| vertex:
|
| Set radius = firstVarEdgeFillet.ImposedVertexRadius(vertex)
:param Reference i_imposed_vertex:
:return: Length
:rtype: Length
"""
return Length(
self.var_rad_edge_fillet.ImposedVertexRadius(
i_imposed_vertex.com_object))
def end_param(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property EndParam() As Length (Read Only)
|
| Gets end parameter.
| Note: Used for law type = 2(Linear) and 3(SType).
|
| Parameters:
|
| EndParam
| Parameter This example retrieves in EParam the end parameter for
| the IntegratedLaw hybrid shape feature.
|
| Dim EParam
| Set EParam = IntegratedLaw.EndParam
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_integrated_law.EndParam)
def get_maximum_length(self, i_range_id: str) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func getMaximumLength(CATBSTR iRangeId) As Length
:param str i_range_id:
:return: Length
:rtype: Length
"""
return Length(
self.defeaturing_filter_with_range.getMaximumLength(i_range_id))
def radius(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Radius() As Length (Read Only)
|
| returns the resulting radius of extremum.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_extremum_polar.Radius)
def distance(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Distance() As Length (Read Only)
|
| Returns the translate distance.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_translate.Distance)
def begin_offset(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property BeginOffset() As Length (Read Only)
|
| Returns the start offset of the line.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_line_bisecting.BeginOffset)
def radius(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Radius() As Length (Read Only)
|
| Returns fillet radius in a CATIALength.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_fillet_bi_tangent.Radius)
def threshold(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Threshold() As Length
|
| Returns or sets Threshold Thickness. Length.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_mid_surface.Threshold)
def offset(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Offset() As Length (Read Only)
|
| Returns the offset value.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_plane_offset.Offset)
def pitch(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Pitch() As Length
|
| Reads / Changes the pitch of the Spiral.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_spiral.Pitch)
def corner_radius_value(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property CornerRadiusValue() As Length
|
| Returns or sets the Corner Radius Value.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_3d_curve_offset.CornerRadiusValue)
def starting_radius(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property StartingRadius() As Length
|
| Reads / Changes the starting radius of the Spiral.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_spiral.StartingRadius)
def dimension(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Dimension() As Length (Read Only)
|
| Returns or sets the limit dimension. This property is valid for the offset
| limit mode only, that is when CatLimitMode is set to catOffsetLimit .
:return: Length
:rtype: Length
"""
return Length(self.limit.Dimension)
def guide_deviation(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property GuideDeviation() As Length (Read Only)
|
| Returns the deviation value (length) from guide curves allowed during a
| sweeping operation in order to smooth it.
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_sweep_circle.GuideDeviation)
def deformation_dist(self) -> Length:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property DeformationDist() As Length
|
| Returns the translate distance (CATIA Parameter).
| Note: Distance value is set or retrieve trough a Literaql
| parameter
| Parameters are value are given in the Part Unit
| Example : if Part Unit for dimensions is mm: for 1 mmm, oDefDist.Value will return 1.000
:return: Length
:rtype: Length
"""
return Length(self.hybrid_shape_bump.DeformationDist)