pycatia.hybrid_shape_interfaces.hybrid_shape_loft

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_loft.HybridShapeLoft(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
HybridShapeLoft

Represents the hybrid shape loft surface feature object.
Role: To access the data of the hybrid shape loft surface feature
object.
This data includes:

The spine
The tangent surfaces to the start and end sections
Guide curves, sections, and couplings

Use the CATIAHybridShapeFactory to create a HybridShapeLoft
object.

LICENSING INFORMATION: Creation of volume result requires GSO
License
if GSO License is not granted , setting of Volume context has not
effect

Use the CATIAHybridShapeFactory to create a HybridShapeLoft
object.

See also:
HybridShapeFactory
add_guide(i_guide: Reference) → None

Note

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

Adds a guide curve to the lofted surface.

Parameters:

iGuide
The guide curve to be added

Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
Parameters:

i_guide (Reference) –

Return type:

None

add_guide_with_tangent(i_guide: Reference, i_tangent: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddGuideWithTangent(Reference iGuide,
Reference iTangent)

Adds a guide curve and a tangent surface to the lofted
surface.

Parameters:

iGuide
The guide curve to be added

Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
iTangent
The tangent surface to be added. The guide curve must be layed on the
tangent

Sub-element(s) supported (see Boundary object): Face.
Parameters:
Return type:

None

add_section_to_loft(i_crv: Reference, i_ori: int, i_point: Reference | VBANothing) → None

Note

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

Retrieves a loft section.

Parameters:

iCrv
Reference to the curve
iOri
Orientation
iPoint
Reference to the Closing Point
Parameters:
Return type:

None

property area_law: Reference

Note

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

Gets or sets the optional area law for multi-sections element definition.
The law is a length law.
Return type:

Reference

property area_law_tolerance: float

Note

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

Gets or sets the tolerance applied to area law. The value is in mm.
Return type:

float

property boolean_operation: int

Note

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

Gets or sets the boolean operation for closed lofted surface. TO BE USED ONLY for Part Loft
(closed loft). BooleanOperation = 1 : No boolean operation. = 2 : Union boolean operation. =
3 : Removal boolean operation. This example retrieves in BoolOp the type of boolean operation
for the Loft hybrid shape feature.

Dim BoolOp
BoolOp = Loft.BooleanOperation
Return type:

int

property canonical_detection: int

Note

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

Returns or sets whether canonical surfaces of the lofted surface are
detected.
Legal values:

0
No detection of canonical surface is performed
1
Detection of planar surfaces only is performed
2
Detection of canonical surfaces is performed
Return type:

int

property comp_end_section_tangent: int

Note

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

Returns or sets whether the tangent surface to the end section of the
lofted surface is computed.
Legal values:

1
The tangent to the end section is computed
2
The tangent to the end section is not computed
Return type:

int

property comp_start_section_tangent: int

Note

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

Returns or sets whether the tangent surface to the start section of the
lofted surface is computed.
Legal values:

1
The tangent to the start section is computed
2
The tangent to the start section is not computed
Return type:

int

property context: int

Note

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

Returns or sets the context on Loft feature.
Legal values:

0 This option creates Lofted surface.
1 This option creates Lofted volume.


Note: Setting volume result requires GSO License.

Example:
This example retrieves in oContext the context for the Loft hybrid
shape feature.

Dim oContext
Set oContext = Loft.Context
Return type:

int

get_area_law_tolerance_parameter() → Length

Note

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

Gets the tolerance parameter applied to area law.
Return type:

Length

get_faces_for_closing(o_start_face: Reference, o_end_face: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetFacesForClosing(Reference oStartFace,
Reference oEndFace)

Gets start and end faces if the tangent is a computed tangent surface to
the start section or end section, from the lofted surface. The section must
have been set as a face.

Parameters:

oStartFace
start face used to close the loft.
oEndFace
end face used to close the loft.
Parameters:
Return type:

None

get_guide(i_pos: int, o_guide: Reference, o_guide_tangent: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetGuide(long iPos,
Reference oGuide,
Reference oGuideTangent)

Gets informations about the guide at a specified position in the list of
the lofted surface.

Parameters:

iPos
position of the guide in the list where the information is
retrieved.
oGuide
the guide curve.
oGuideTangent
the tangent corresponding to the guide curve.
Parameters:
Return type:

None

get_nb_of_guides() → int

Note

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

Returns the number of guides in the loft object.

Parameters:

oSize
Number of guides in the loft.

Example:
This example retrieves the number of guides in the hybShpLoft
hybrid shape Loft.

Dim oSize As long
oSize = hybShpLoft.GetNbOfGuides
Return type:

int

get_section_from_loft(i_rank: int, o_crv: Reference, o_ori: int, o_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetSectionFromLoft(long iRank,
Reference oCrv,
long oOri,
Reference oPoint)

Retrieves a loft section information.

Parameters:

iRank
The index of the section
oCrv
The reference to the curve
oOri
The orientation value
oPoint
The reference to the point
Parameters:
Return type:

None

get_spine(o_spine_type: int, o_spine: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetSpine(long oSpineType,
Reference oSpine)

Gets the spine of the lofted surface.

Parameters:

oSpineType
type of spine = 1 : User defined spine. = 2 : Automatically computed spine.
oSpine
curve used as a spine, if the spine is user defined
one.
Parameters:

  • o_spine_type (int) –

  • o_spine (Reference) –

Return type:

None

get_start_and_end_section_tangent(o_start_section_tangent: Reference, o_end_section_tangent: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetStartAndEndSectionTangent(Reference
oStartSectionTangent,
Reference oEndSectionTangent)

Gets the start and end section tangents of the lofted
surface.

Parameters:

oStartSectionTangent
tangent surface at start section.
oEndSectionTangent
tangent surface at end section.
Parameters:
Return type:

None

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 to the loft.

Parameters:

iPosition
The position of the coupling in the list of couplings. If 0 is
specified, the coupling is inserted at the end of the
list.
Sub-element(s) supported (see

Boundary object): Vertex.
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 lofted
surface.

Parameters:

iCouplingIndex
The index of the coupling in the list of coupling where the point
wil be inserted.
iPosition
The position of the coupling point in the list of coupling points.
If 0 is specified, the coupling point is inserted at the end of the list.

iPoint
The point to be inserted. The point must be layed on the section
with the same position.
Sub-element(s) supported (see

Boundary object): ScVertex.
Parameters:

  • i_coupling_index (int) –

  • i_position (int) –

  • i_point (Reference) –

Return type:

None

insert_section_to_loft(i_type: bool, i_crv: Reference, i_ori: int, i_point: Reference, i_section_ref: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub InsertSectionToLoft(boolean iType,
Reference iCrv,
long iOri,
Reference iPoint,
Reference iSectionRef)

Inserts a loft section.

Parameters:

iType
iType if set to true section is added After and iType if set to
false section is added Before iSectionRef
iCrv
Reference to the curve
iOri
Orientation
iPoint
Reference to the Closing Point
iSectionRef
iSectionRef is the section before and after which section is
added.
Parameters:
Return type:

None

modify_guide_curve(i_guide: Reference, i_new_guide: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifyGuideCurve(Reference iGuide,
Reference iNewGuide)

Modifies the curve of a guide from the lofted surface.

Parameters:

iGuide
guide curve to be replaced.
iNewGuide
new guide curve, will replace iGuide.
Parameters:
Return type:

None

modify_section_curve(i_section: Reference, i_new_section: Reference, o_curve_section: Reference, o_closing_point: Reference, o_pt_diag: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifySectionCurve(Reference iSection,
Reference iNewSection,
Reference oCurveSection,
Reference oClosingPoint,
long oPtDiag)

Modifies the curve of section from the lofted surface.

Parameters:

iSection
section curve to be replaced.
iNewSection
section will replace iSection, can be a curve or a face

oCurveSection
if iSection is a face, oCurveSection is the boundary of the face.
oCurveSection is used as section curve. if Part design, the face is used to
close the Loft.
oClosingPoint
if iSection is a closed curve, oClosingPoint is a new closing point
of iSection. if iSection is a face, oClosingPoint is a new closing point the
boundary of iSection.
oPtDiag
Information on closing point =
0 : No closing point has been created nor retrieved.
1 : A closing point has been created as a vertex.
2 : A closing point has been created as an extremum.
3 : A closing point has been retrieved as an extremum.
Parameters:
Return type:

None

modify_section_orient(i_section: Reference, i_orient: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifySectionOrient(Reference iSection,
long iOrient)

Modifies the orientation of the curve of a section from the lofted
surface.

Parameters:

iSection
section curve to be modified.
iOrient
orientation of the section curve =
1 : same orientation.
-1 : inverted orientation.
2 : ko orientation.
Parameters:

  • i_section (Reference) –

  • i_orient (int) –

Return type:

None

property relimitation: int

Note

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

Returns or sets the relimitation type between sections of the
loft.
NOT YET IMPLEMENTED.
Legal values:

1
The loft will be swept along the spine, then relimited by the start
section and the end section
2
The loft will be swept along the spine.

If the spine is a user spine, then the loft is limited by the spine
extremities
If the spine is a computed spine, then the loft is
limited:
By the start section and the end section, if there is no
guide
By the guides extremities, if there are guides

3
The loft will be swept along the spine, then relimited by the first
section,

If the spine is a user spine, then the loft is limited by the spine
extremity opposite to the first section
If the spine is a computed spine, then the loft is
limited:
By the last section, if there is no guide
By the guides extremities opposite to the first section, if
there are guides

4
The loft will be swept along the spine, then relimited by the last
section,

If the spine is a user spine, then the loft is limited by the spine
extremity opposite to the last section
If the spine is a computed spine, then the loft is
limited:
By the first section, if there is no guide
By the guides extremities opposite to the last section, if
there are guides
Return type:

int

remove_face_for_closing(i_section: Reference) → None

Note

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

Removes face used to close the lofted surface.

Parameters:

iSection
section curve.
Parameters:

i_section (Reference) –

Return type:

None

remove_guide(i_guide: Reference) → None

Note

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

Removes a guide curve from the lofted surface.

Parameters:

iGuide
The guide curve to be removed

Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
Parameters:

i_guide (Reference) –

Return type:

None

remove_guide_tangent(i_guide: Reference) → None

Note

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

Removes a tangent surface of a guide from the lofted
surface.

Parameters:

iGuide
guide curve of the guide from which the tangent will be
removed.
Parameters:

i_guide (Reference) –

Return type:

None

remove_section(i_section: Reference) → None

Note

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

Removes a loft section from the lofted surface.

Parameters:

iSection
The loft section to remove

Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
Parameters:

i_section (Reference) –

Return type:

None

remove_section_point(i_section: Reference) → None

Note

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

Removes a closing point of a section from the lofted surface. The curve
section must be closed curve.

Parameters:

iSection
section curve of the section from which the point will be
removed.
Parameters:

i_section (Reference) –

Return type:

None

remove_section_tangent(i_section: Reference) → None

Note

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

Removes the tangent surface of a section from the lofted surface. The
section must be the start section or the end section of the
loft.

Parameters:

iSection
section curve of the section from which the tangent will be
removed.
Parameters:

i_section (Reference) –

Return type:

None

property section_coupling: int

Note

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

Returns or sets the type of coupling between sections of the
loft.
Legal values:

1
The curves will be coupled according to the curvilinear abscissa
ratio
2
if each curve has the same number of tangency discontinuity points,
then these points will be coupled, otherwise an error message is
displayed
3
if each curve has the same number of tangency and curvature
discontinuity points, then tangency discontinuity points will be coupled, and
after curvature discontinuity points will be coupled, otherwise an error
message is displayed
4
if each curve has the same number of vertices, then these points will
be coupled, otherwise an error message is displayed
Return type:

int

set_end_face_for_closing(i_face: Reference) → None

Note

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

Sets a face to the end section from the lofted surface.

Parameters:

iFace
The face to close the loft (Part design only).
Sub-element(s) supported (see

Boundary object): Face.
Parameters:

i_face (Reference) –

Return type:

None

set_end_section_tangent(i_tangent_section: Reference) → None

Note

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

Sets a tangent surface to the end section from the lofted
surface.

Parameters:

iTangentSection
The tangent surface to be added. The end curve section must lay on
the surface.
Sub-element(s) supported (see

Boundary object): Face.
Parameters:

i_tangent_section (Reference) –

Return type:

None

set_spine(i_spine: Reference) → None

Note

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

Sets the spine to the lofted surface.

Parameters:

iSpine
The curve to be added as a spine.
Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
Parameters:

i_spine (Reference) –

Return type:

None

set_start_face_for_closing(i_face: Reference) → None

Note

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

Sets a face to the start section from the lofted surface.

Parameters:

iFace
The face to close the loft (Part design only).
Sub-element(s) supported (see

Boundary object): Face.
Parameters:

i_face (Reference) –

Return type:

None

set_start_section_tangent(i_tangent_section: Reference) → None

Note

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

Sets a tangent surface to the start section from the lofted
surface.

Parameters:

iTangentSection
The tangent surface to be added. The start curve section must lay
on the surface.
Sub-element(s) supported (see

Boundary object): Face.
Parameters:

i_tangent_section (Reference) –

Return type:

None

property smooth_angle_threshold: float

Note

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

Returns or sets the angular threshold under which discontinuities (moving
frame, tangency net on reference surface) will be smoothed.
Return type:

float

property smooth_angle_threshold_activity: bool

Note

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

Returns or sets whether a angular threshold is allowed or not during
lofting operation in order to smooth it.
Legal values:

TRUE
The angular threshold value is used during the lofting
operation
FALSE
The angular threshold value is not used during the lofting
operation
Return type:

bool

property smooth_deviation: float

Note

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

Returns or sets the deviation value (length) allowed during lofting
operation in order to smooth it.
Return type:

float

property smooth_deviation_activity: bool

Note

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

Returns or sets whether a deviation is allowed or not during lofting
operation in order to smooth it.
Legal values:

TRUE
The deviation value is used during the lofting
operation
FALSE
The deviation value is not used during the lofting
operation
Return type:

bool