pycatia.hybrid_shape_interfaces.hybrid_shape_integrated_law

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_integrated_law.HybridShapeIntegratedLaw(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
HybridShapeIntegratedLaw

Represents the hybrid shape “integrated” law feature object.
Role: To access the data of the hybrid shape “integrated” law feature
object.

Use the CATIAHybridShapeFactory to create a HybridShapeIntegratedLaw
object.

See also:
HybridShapeFactory.AddNewIntegratedLaw
property advanced_law: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property AdvancedLaw() As Reference

Gets or sets the external law.
Note: Used for law type = 4(Advanced)

Parameters:

AdvancedLaw
External Law This example retrieves in ALaw the external law for
the IntegratedLaw hybrid shape feature.

Dim ALaw
Set ALaw = IntegratedLaw.AdvancedLaw
Return type:

Reference

append_new_point_and_param(i_point: Reference, i_param: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AppendNewPointAndParam(Reference iPoint,
long iParam)

Sets ‘Point on spine’ and associated parameter.
Note: Used for law type = 5(Implicit)

Parameters:

iPoint
Point on spine
iParam
Corresponding parameter
Parameters:
Return type:

None

property end_param: Length

Note

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 type:

Length

get_point_and_param(i_pos: int, o_point: Reference, o_param: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetPointAndParam(long iPos,
Reference oPoint,
Reference oParam)

Gets the point on spine and associated parameter at a given
position.
Note: Used for law type = 5(Implicit)

Parameters:

iPos
given position
oPoint
point on spine
oParam
corresponding parameter
Parameters:
Return type:

None

get_size() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSize() As long

Gets the size of the list in the law i.e. number of points in the list of
the law.

Parameters:

oSize
size of the list.
Return type:

int

property implicit_law_interpolation_mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ImplicitLawInterpolationMode() As long

Gets or sets Interpolation mode for implicit law.
Note: Used for law type = 5(Implicit)

Parameters:

ImplicitLawInterpolationMode
Implicit law interpolation mode ImplicitLawInterpolationMode =
0 : CATGSMImplicitLawInterpo_None =
1 : CATGSMImplicitLawInterpo_Linear =
2 : CATGSMImplicitLawInterpo_Cubic This example retrieves in InterpolLawMode the
Interpolation mode for the IntegratedLaw hybrid shape feature.

Dim InterpolLawMode
Set InterpolLawMode = IntegratedLaw.ImplicitLawInterpolationMode
Return type:

int

property invert_mapping_law: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property InvertMappingLaw() As boolean

Gets or sets the mapping orientation of the law.

Parameters:

InvertMappingLaw
False : Law is applied from the beginning to the end of the curve
(mapping is not inverted).
True : Law is applied from the end to the beginning of the curve (mapping is inverted).
This example retrieves in IMappingLaw the mapping orientation of the law for the
IntegratedLaw hybrid shape feature.

Dim IMappingLaw
Set IMappingLaw = IntegratedLaw.InvertMappingLaw
Return type:

bool

property pitch_law_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property PitchLawType() As long

Gets or sets pitch law type.

Parameters:

PitchLawType
Type of law PitchLawType = 0 : None = 1 : Constant = 2 : Linear = 3 : SType =
4 : Advanced = 5 : Implicit

This example retrieves in PLawType the pitch law type for the IntegratedLaw hybrid shape feature.

Dim PLawType
Set PLawType = IntegratedLaw.PitchLawType
Return type:

int

remove_all_points_and_params() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveAllPointsAndParams()

Removes all the points and associated parameters.
Note: Used for law type = 5(Implicit)
Return type:

None

remove_point_and_param(i_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemovePointAndParam(Reference iPoint)

Removes a point and its parameter. for law type = 5(Implicit)

Parameters:

iSpecPoint
Point to remove
Parameters:

i_point (Reference) –

Return type:

None

set_end_param(i_end_param: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetEndParam(long iEndParam)

Sets end parameter.
Note: Used for law type = 2(Linear) and 3(SType).

Parameters:

iEndParam
Parameter
Parameters:

i_end_param (int) –

Return type:

None

set_start_param(i_start_param: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetStartParam(long iStartParam)

Sets start parameter.
Note: Used for law type = 1(Constant) ,2(Linear) and 3(SType).

Parameters:

iStartParam
Parameter
Parameters:

i_start_param (int) –

Return type:

None

property spine: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Spine() As Reference

Gets or sets Spine for implicit law.
Note: Used for law type = 5 (Implicit)

Parameters:

Spine
Spine on which implicit law inputs points are defined This example
retrieves in Spine1 the spine for the IntegratedLaw hybrid shape
feature.

Dim Spine1
Set Spine1 = IntegratedLaw.Spine
Return type:

Reference

property start_param: Length

Note

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 type:

Length