pycatia.hybrid_shape_interfaces.hybrid_shape_blend¶
Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384
Warning
The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.
- class pycatia.hybrid_shape_interfaces.hybrid_shape_blend.HybridShapeBlend(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeHybridShapeBlendRepresents the hybrid shape blended surface object.Role: To access the data of the hybrid shape blended surfaceobject.This data includes:Two support surfaces, one at each limit of the blendedsurfaceTwo curves, one for each support surfaceThe curve closing pointsUse the CATIAHybridShapeFactory to create a HybridShapeBlendobject.See also:HybridShapeFactory- property coupling: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Coupling() As longReturns or sets the type of coupling between the limits of theblend.Legal values: The values representing the type of coupling canbe:1Ratio: the curves are coupled according to the curvilinear abscissaratio2Tangency: the curves are coupled according to their tangencydiscontinuity points. If they do not have the same number of tangencydiscontinuity points, they cannot be coupled and an error message is displayed3Tangency then curvature: the curves are coupled according to theirtangency discontinuity points first, then according to their curvaturediscontinuity points. If they do not have the same number of tangency andcurvature discontinuity points, they cannot be coupled and an error message isdisplayed4Vertices: the curves are coupled according to their vertices. If theydo not have the same number of vertices, they cannot be coupled and an errormessage is displayed5Spine: coupling is completely driven by a curve (called spine)Example:This example retrieves in CouplingVal the coupling value of theShpBlend hybrid shape blended feature.CouplingVal = ShpBlend.Coupling
- Return type:
int
- get_border_mode(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetBorderMode(long iBlendLimit) As longReturns the type of border to a limit of the blend.Parameters:iBlendLimitThe limit of the blend whose type of border is to beretrieved.Legal values: 1 for the first limit, and 2 for the second oneReturns:The type of borderLegal values:1The border of the blend will be tangent to the border of thesupport surface, or if the curve ends on the border of a face of the supportsurface, then the border of the blend will be tangent to the border face.2The border of the blend is not constrained.Example:This example retrieves in BorderType the type of border of the first limitof the ShpBlend hybrid shape blended feature.BorderType = ShpBlend.GetBorderMode(1)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_closing_point(i_blend_limit: int) Reference ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetClosingPoint(long iBlendLimit) As ReferenceReturns the closing point of a closed curve of the blend.Parameters:iBlendLimitThe limit of the blend whose curve closing point isreturned.Legal values: 1 for the first curve, and 2 for the second oneReturns:The retrieved closing pointExample:This example retrieves in ClosingPoint the closing point of the curve ofthe second limit of the ShpBlend hybrid shape blendedfeature.Dim ClosingPoint As ReferenceClosingPoint = ShpBlend.GetClosingPoint(2)
- Parameters:
i_blend_limit (int) –
- Return type:
- get_continuity(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetContinuity(long iBlendLimit) As longRetrieves the continuity of a limit of the blend.Parameters:iBlendLimitThe limit of the blend whose continuity is to beretrieved.Legal values: 1 for the first limit, and 2 for the second oneReturns:The retrieved continuity.Legal values:0Point continuity1Tangency continuity2Curvature continuityExample:This example retrieves in Continuity the continuity of the second limit ofthe ShpBlend hybrid shape blended feature.Continuity = ShpBlend.GetContinuity(2)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_curve(i_blend_limit: int) Reference ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetCurve(long iBlendLimit) As ReferenceReturns a curve from the blend.Parameters:iBlendLimitThe limit of the blend from which the curve will beretrieved.Legal values: 1 for the first curve, and 2 for the second oneReturns:The retrieved curveExample:This example retrieves in BlendCurve the curve of the second limit of theShpBlend hybrid shape blended feature.Dim BlendCurve As ReferenceBlendCurve = ShpBlend.GetCurve(2)
- Parameters:
i_blend_limit (int) –
- Return type:
- get_orientation(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetOrientation(long iBlendLimit) As longReturns the orientation of a curve of the blend.Parameters:iBlendLimitThe limit of the blend whose curve orientation is to beretrieved.Legal values: 1 for the first curve, and 2 for the second oneReturns:The orientation to set to the curve.Legal values: 1 for direct and -1 for reverseExample:This example retrieves in Orientation the orientation of the second limitof the ShpBlend hybrid shape blended feature.Orientation = ShpBlend.GetOrientation(2)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_ruled_developable_surface_connection(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetRuledDevelopableSurfaceConnection(long iBlendLimit) AslongReturns or sets the ruled developable surface connectiontype.Parameters:iBlendLimitThe limit of the blend for which the connection type is to beset.Legal values: 1 for the start limit, and 2 for the end oneoBlendConnectionThe value of connection typeLegal values:1Connect to both extremities2Free first curve3Free second curve
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_support(i_blend_limit: int) Reference ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetSupport(long iBlendLimit) As ReferenceReturns a support from the blend.Parameters:iBlendLimitThe limit of the blend whose support is to beretrieved.Legal values: 1 for the first support, and 2 for the second oneReturns:The retrieved support surfaceExample:This example retrieves in SupportSurf the support surface of the secondlimit of the ShpBlend hybrid shape blended feature.Dim SupportSurf As ReferenceSupportSurf = ShpBlend.GetSupport(2)
- Parameters:
i_blend_limit (int) –
- Return type:
- get_tension_in_double(i_blend_limit: int, i_rank: int) RealParam ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetTensionInDouble(long iBlendLimit,long iRank) As RealParamReturns the tension values of a limit of the blend.Parameters:iBlendLimitThe limit of the blend from which the tension type and values areto be retrieved.Legal values: 1 for the first limit, and 2 for the second oneiRankThe rank of the value to retrieve among those available, dependingon the tension type.Legal values: iRank can take the following values:1With default tension and constant tension, for the uniqueavailable value, and with linear tension for the first value2With linear tension for the second valueReturns:The retrieved tension valueExample:This example retrieves in TensionVal the tension value of the tension,supposed to be a constant tension, of the first limit of the ShpBlend hybridshape blended feature.Dim ConstTensionVal As RealParamSet ConstTensionVal = ShpBlend.GetTensionInDouble(1, 1)
- Parameters:
i_blend_limit (int) –
i_rank (int) –
- Return type:
- get_tension_type(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetTensionType(long iBlendLimit) As longReturns the tension type of a limit of the blend.Parameters:iBlendLimitThe limit of the blend from which the tension type is to beretrieved.Legal values: 1 for the first limit, and 2 for the second oneReturns:The value of tension typeLegal values:1Default tension2Constant tension3Linear tensionExample:This example retrieves in TensionType the tension type of the first limitof the ShpBlend hybrid shape blended feature.TensionType.GetTensionType(1)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_transition(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetTransition(long iBlendLimit) As longReturns the transition orientation from a limit of theblend.Let T be the tangent to the wire, and N be the normal to the skin body. Thetransition orientation defines how the blend goes from the initial wires: ittakes the direction of iTransition*(T^N), where ^ is the crossproduct.Parameters:iBlendLimitThe limit of the blend whose transition orientation is to beretrieved.Legal values: 1 for the first support, and 2 for the second oneReturns:The retrieved value of transition orientation.Legal values: 1 for direct and -1 for reverseExample:This example retrieves in TransOrientation the transition orientation ofthe second limit of the ShpBlend hybrid shape blendedfeature.TransOrientation = ShpBlend.GetTransition(2)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- get_trim_support(i_blend_limit: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetTrimSupport(long iBlendLimit) As longReturns whether a support of the blend will be trimmedoff.If the support is set to be trimmed, it will be trimmed using the curvethen joined to the blend.Parameters:iBlendLimitThe limit of the blend whose support is to betrimmed.Legal values: 1 for the first limit, and 2 for the second oneReturns:The trim support modeLegal values:1No trim2The support will be trimmedExample:This example retrieves whether the second limit of the ShpBlend hybridshape blended feature should be trimmed off.IsTrimmed = ShpBlend.GetTrimSupport(2)
- Parameters:
i_blend_limit (int) –
- Return type:
int
- insert_coupling(i_position: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub InsertCoupling(long iPosition)Inserts a coupling into the blend.Parameters:iPositionThe position of the coupling in the list of couplings. SettingiPosition to 0 inserts the coupling at the end of the list.Example:This example inserts a coupling at the end of the coupling list of theShpBlend hybrid shape blended feature.ShpBlend.InsertCouplingt 0
- Parameters:
i_position (int) –
- Return type:
None
- insert_coupling_point(i_coupling_index: int, i_position: int, i_point: Reference) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub InsertCouplingPoint(long iCouplingIndex,long iPosition,Reference iPoint)Inserts a coupling point to a coupling of the blend.Parameters:iCouplingIndexThe index of the coupling in the list of couplings into which thecoupling point will be inserted.iPositionThe position of the coupling point in the list of coupling points.Setting iPosition to 0 inserts the coupling point at the end of the list.iPointThe coupling point to be inserted. This point must lay on thesection with the same position.Sub-element(s) supported (seeBoundary object): Vertex.Example:This example inserts the Point23 point into the third coupling at the endof the list of coupling points of the ShpBlend hybrid shape blendedfeature.ShpBlend.InsertCouplingPoint 3, 0, Point23
- Parameters:
i_coupling_index (int) –
i_position (int) –
i_point (Reference) –
- Return type:
None
- property ruled_developable_surface: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property RuledDevelopableSurface() As booleanReturns or sets the ruled developable surface mode.TRUE means that the mode is enabled and FALSE means that it is disabled.
- Return type:
bool
- set_border_mode(i_blend_limit: int, i_border: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetBorderMode(long iBlendLimit,long iBorder)Sets the type of border to a limit of the blend.Parameters:iBlendLimitThe limit of the blend whose type of border is to beset.Legal values: 1 for the first limit, and 2 for the second oneiBorderThe type of borderLegal values:1The border of the blend will be tangent to the border of thesupport surface, or if the curve ends on the border of a face of the supportsurface, then the border of the blend will be tangent to the border face.2The border of the blend is not constrained.3The border of the blend will be tangent to the border of thesupport surface at the start extremity of the curve, or if the curve ends onthe border of a face of the support surface, then the border of the blend willbe tangent to the border face at the start extremity of the curve.4The border of the blend will be tangent to the border of thesupport surface at the end extremity of the curve, or if the curve ends on theborder of a face of the support surface, then the border of the blend will betangent to the border face at the end extremity of the curve.Example:This example sets the type of border of the second limit of theShpBlend hybrid shape blended feature to “noconstraint”.ShpBlend.SetBorderMode 2, 2
- Parameters:
i_blend_limit (int) –
i_border (int) –
- Return type:
None
- set_closing_point(i_blend_limit: int, i_closing_point: Reference) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetClosingPoint(long iBlendLimit,Reference iClosingPoint)Sets a new closing point to a closed curve of the blend.Parameters:iBlendLimitThe limit of the blend whose curve will be set a new closingpoint.Legal values: 1 for the first curve, and 2 for the second oneiClosingPointThe closing point to be set. This point must lay on the curve ofthe blend limit.Sub-element(s) supported (seeBoundary object): Vertex.Example:This example sets the Point10 point as the closing point to the secondlimit of the ShpBlend hybrid shape blended feature.ShpBlend.SetClosingPoint 2, Point10
- Parameters:
i_blend_limit (int) –
i_closing_point (Reference) –
- Return type:
None
- set_continuity(i_blend_limit: int, i_continuity: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetContinuity(long iBlendLimit,long iContinuity)Sets the continuity to a limit of the blend.Parameters:iBlendLimitThe limit of the blend whose continuity is to beset.Legal values: 1 for the first limit, and 2 for the second oneiContinuityThe continuity to setLegal values:0Point continuity1Tangency continuity2Curvature continuityExample:This example sets the continuity of the second limit of the ShpBlendhybrid shape blended feature to tangency continuity.ShpBlend.SetContinuity 2, 1
- Parameters:
i_blend_limit (int) –
i_continuity (int) –
- Return type:
None
- set_curve(i_blend_limit: int, i_curve: Reference) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetCurve(long iBlendLimit,Reference iCurve)Sets a curve to the blend.Parameters:iBlendLimitThe limit of the blend to which the curve will beset.Legal values: 1 for the first curve, and 2 for the second oneiCurveThe curve to be set.Sub-element(s) supported (seeBoundary object): TriDimFeatEdge and BiDimFeatEdge.Example:This example sets the CurveForBlend curve to the second limit of theShpBlend hybrid shape blended feature.ShpBlend.SetCurve 2, CurveForBlend
- Parameters:
i_blend_limit (int) –
i_curve (Reference) –
- Return type:
None
- set_orientation(i_blend_limit: int, i_orientation: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetOrientation(long iBlendLimit,long iOrientation)Sets the orientation of a curve of the blend.Parameters:iBlendLimitThe limit of the blend whose curve orientation is to beset.Legal values: 1 for the first curve, and 2 for the second oneiOrientationThe orientation to set to the curve.Legal values: 1 for direct and -1 for reverseExample:This example sets the orientation of the second limit of the ShpBlendhybrid shape blended feature to direct.ShpBlend.SetOrientation 2, 1
- Parameters:
i_blend_limit (int) –
i_orientation (int) –
- Return type:
None
- set_ruled_developable_surface_connection(i_blend_limit: int, i_blend_connection: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetRuledDevelopableSurfaceConnection(long iBlendLimit,long iBlendConnection)
- Parameters:
i_blend_limit (int) –
i_blend_connection (int) –
- Return type:
None
- set_smooth_angle_threshold(i_angle: float) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetSmoothAngleThreshold(double iAngle)Sets the angular threshold.Parameters:iAngleThe angular threshold
- Parameters:
i_angle (float) –
- Return type:
None
- set_smooth_deviation(i_length: float) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetSmoothDeviation(double iLength)Sets the deviation value (length) from guide curves allowed during sweepingoperation in order to smooth it.Parameters:iLengthThe deviation value
- Parameters:
i_length (float) –
- Return type:
None
- set_support(i_blend_limit: int, i_support: Reference) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetSupport(long iBlendLimit,Reference iSupport)Sets a support to the blend.Parameters:iBlendLimitThe limit of the blend whose support is to be set.Legal values: 1 for the first support, and 2 for the second oneiSupportThe support surface to be set. The curve of the blend limit mustlay on the surface.Sub-element(s) supported (seeBoundary object): Face.Example:This example sets the SupportSurf surface as the support of the secondlimit of the ShpBlend hybrid shape blended feature.ShpBlend.SetSupport 2, SupportSurf
- Parameters:
i_blend_limit (int) –
i_support (Reference) –
- Return type:
None
- set_tension_in_double(i_blend_limit: int, i_tension_type: int, i_first_tension: float, i_second_tension: float) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetTensionInDouble(long iBlendLimit,long iTensionType,double iFirstTension,double iSecondTension)Sets the tension values to a limit of the blend. The values must beexpressed as doubles and must be positive.Parameters:iBlendLimitThe limit of the blend to which the tension values are to beset.Legal values: 1 for the first limit, and 2 for the second oneiTensionTypeThe tension typeLegal values:1Default tension2Constant tension3Linear tensioniFirstTensionThe value for the first tension. It must be used with any tensiontypeLegal values: it must be a double and positive.iSecondTensionThe value for the second tension. It can be used with lineartension onlyLegal values: it must be a double and positive.Example:This example sets the tension values of the tension, supposed to be alinear tension, of the first limit of the ShpBlend hybrid shape blended featureto respectively 1.5 and 0.5.ShpBlend.SetTensionInDouble 1, 3, 1.5, 0.5
- Parameters:
i_blend_limit (int) –
i_tension_type (int) –
i_first_tension (float) –
i_second_tension (float) –
- Return type:
None
- set_tension_type(i_blend_limit: int, i_tension_type: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetTensionType(long iBlendLimit,long iTensionType)Sets the tension type of a limit of the blend.Parameters:iBlendLimitThe limit of the blend for which the tension type is to beset.Legal values: 1 for the first limit, and 2 for the second oneiBlendLimitThe value of tension typeLegal values:1Default tension2Constant tension3Linear tension4SType tensionExample:This example sets the tension type as Default Tension for the firstlimit of the ShpBlend hybrid shape blended feature.ShpBlend.SetTensionType 1, 1
- Parameters:
i_blend_limit (int) –
i_tension_type (int) –
- Return type:
None
- set_transition(i_blend_limit: int, i_transition: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetTransition(long iBlendLimit,long iTransition)Sets the transition orientation to a limit of the blend.Role: Let T be the tangent to the wire, and N be the normal to the skinbody. The transition orientation defines how the blend goes from the initialwires: it takes the direction of iTransition*(T^N), where ^ is the crossproduct.Parameters:iBlendLimitThe limit of the blend whose transition orientation is to beset.Legal values: 1 for the first support, and 2 for the second oneiTransitionThe value of transition orientation.Legal values: 1 for direct and -1 for reverseExample:This example sets the transition orientation of the second limit of theShpBlend hybrid shape blended feature to reverse.ShpBlend.SetTransition 2, -1
- Parameters:
i_blend_limit (int) –
i_transition (int) –
- Return type:
None
- set_trim_support(i_blend_limit: int, i_trim_support: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetTrimSupport(long iBlendLimit,long iTrimSupport)Sets whether a support of the blend is to be trimmed off.If the support is set to be trimmed, it will be trimmed using the curvethen joined to the blend.Parameters:iBlendLimitThe limit of the blend whose support is to betrimmed.Legal values: 1 for the first limit, and 2 for the second oneiTrimSupportThe trim support modeLegal values:1No trim2The support will be trimmedExample:This example sets that the second limit of the ShpBlend hybrid shapeblended feature should be trimmed off.ShpBlend.SetTrimSupport 2, 2
- Parameters:
i_blend_limit (int) –
i_trim_support (int) –
- Return type:
None
- property smooth_angle_threshold: Angle¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SmoothAngleThreshold() As Angle (Read Only)Returns the angular threshold.
- Return type:
- property smooth_angle_threshold_activity: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SmoothAngleThresholdActivity() As booleanReturns or sets information whether a blending operation is smoothed ornot.TRUE if the blending operation is smoothed, or FALSE otherwise (FALSE ifnot specified).
- Return type:
bool
- property smooth_deviation: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SmoothDeviation() As Length (Read Only)Returns the deviation value (length) from guide curves allowed during asweeping operation in order to smooth it.
- Return type:
- property smooth_deviation_activity: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SmoothDeviationActivity() As booleanReturns or sets information whether a deviation from guide curves isallowed or not.Gives the information on performing smoothing during blendingoperation.TRUE if a deviation from guide curves is allowed, or FALSE otherwise (FALSEif not specified).
- Return type:
bool
- property spine: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Spine() As ReferenceReturns or sets a curve used as spine for coupling in Blend computation.Setting the spine curve also changes coupling mode to CATGSMSpineCoupling. Inorder to remove the spine, set another coupling mode.Parameters:iSpinespine curve
- Return type:
- unset_closing_point(i_blend_limit: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub UnsetClosingPoint(long iBlendLimit)Unsets the closing point of a closed curve of the blend.Parameters:iBlendLimitThe limit of the blend whose curve closing point isunset.Legal values: 1 for the first curve, and 2 for the second oneExample:This example unsets the closing point of the second limit of theShpBlend hybrid shape blended feature.ShpBlend.UnsetClosingPoint 2
- Parameters:
i_blend_limit (int) –
- Return type:
None
- unset_support(i_blend_limit: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub UnsetSupport(long iBlendLimit)Unsets a support from the blend.Parameters:iBlendLimitThe limit of the blend whose support is to beunset.Legal values: 1 for the first support, and 2 for the second oneExample:This example unsets the support surface of the second limit of theShpBlend hybrid shape blended feature.ShpBlend.UnsetSupport 2
- Parameters:
i_blend_limit (int) –
- Return type:
None