pycatia.hybrid_shape_interfaces.hybrid_shape_spine

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_spine.HybridShapeSpine(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
HybridShapeSpine

Represents the hybrid spine curve feature object.
Role:Use the CATIAHybridShapeFactory to create a HybridShapeSpine
object.

See also:
HybridShapeFactory
add_guide(i_guide: pycatia.in_interfaces.reference.Reference) → None

Note

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

Adds a guide to the spine curve.

Parameters:

iGuide
The guide curve to be added
Parameters

i_guide (Reference) –

Returns

None

Return type

None

add_section(i_section: pycatia.in_interfaces.reference.Reference) → None

Note

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

Adds a section or a plane to the spine curve.

Parameters:

iSection
The section curve or plane to be added

Sub-element(s) supported (see

Boundary object): PlanarFace.
Parameters

i_section (Reference) –

Returns

None

Return type

None

get_guide(i_idx: int, op_ia_guide: pycatia.in_interfaces.reference.Reference) → None

Note

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

Retrieves a guide .

Parameters:

iIdx
The index of the guide
opIAGuide
The guide retrieved
Parameters

  • i_idx (int) –

  • op_ia_guide (Reference) –

Returns

None

Return type

None

get_number_of_guides() → int

Note

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

Retrieves number of guides in a spine curve.

Parameters:

oNbGuides
Number of guides in a spine curve
Returns

int

Return type

int

get_number_of_sections() → int

Note

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

Retrieves number of sections in a spine curve.

Parameters:

oNbSections
Number of sections in a spine curve
Returns

int

Return type

int

get_section(i_idx: int, o_section: pycatia.in_interfaces.reference.Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetSection(long iIdx,
Reference oSection)

Retrieves a section or a plane.

Parameters:

iIdx
The index of the section
oSection
The section retrieved
Parameters
Returns

None

Return type

None

modify_guide_curve(ip_ia_guide: pycatia.in_interfaces.reference.Reference, ip_ia_new_guide: pycatia.in_interfaces.reference.Reference) → None

Note

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

Modifies a guide from the spine curve.

Parameters:

ipIAGuide
The guide curve to be replaced.
ipIANewGuide
The new guide curve or plane which replaces the old
one.
Parameters
Returns

None

Return type

None

modify_section_curve(ip_ia_section: pycatia.in_interfaces.reference.Reference, ip_ia_new_section: pycatia.in_interfaces.reference.Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifySectionCurve(Reference ipIASection,
Reference ipIANewSection)

Modifies a section or a plane from the spine curve.

Parameters:

ipIASection
The section curve or plane to be replaced.
ipIANewSection
The new section curve or plane which replaces the old
one.
Parameters
Returns

None

Return type

None

property orientation

Note

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

Gets or Sets the orientation. Orientation by reference with the normal to
the first section/plane
Returns

int

Return type

int

remove_guide(i_guide: pycatia.in_interfaces.reference.Reference) → None

Note

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

Removes a guide from the spine curve.

Parameters:

iGuide
The guide curve to be removed.
Parameters

i_guide (Reference) –

Returns

None

Return type

None

remove_section(i_section: pycatia.in_interfaces.reference.Reference) → None

Note

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

Removes a section or a plane from the spine curve.

Parameters:

iSection
The section curve or plane to be removed.
Sub-element(s) supported (see

Boundary object): PlanarFace.
Parameters

i_section (Reference) –

Returns

None

Return type

None

set_start_point(i_point: pycatia.in_interfaces.reference.Reference) → None

Note

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

Sets the start point of the spine curve.

Parameters:

iPoint
The point to be set as the spine curve start
point.
Sub-element(s) supported (see

Boundary object): Vertex.
Parameters

i_point (Reference) –

Returns

None

Return type

None

property start_point

Note

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

Returns or sets the start point of the spine.
Returns

Reference

Return type

Reference