pycatia.hybrid_shape_interfaces.hybrid_shape_wrap_curve

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_wrap_curve.HybridShapeWrapCurve(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
HybridShapeWrapCurve

Represents the hybrid shape wrap curve surface object.
Role: To access the data of the hybrid shape wrap curve surface
object.

This data includes:

Two support surfaces, one at each limit of the wrap curve
surface
Two curves, one for each support surface
The curve closing points

Use the CATIAHybridShapeFactory to create a HybridShapeWrapCurve
object.

See also:
HybridShapeFactory
property first_curves_constraint: int

Note

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

Returns or sets constraint at first curves of the
WrapCurve.
Legal values:
1 = no constraint
2 = Deformed surface will have the same tangency and the same curvature as the original surface
at first curves.

Example:
This example retrieves in FirstCurvesConstraint the constraint at first
curves of the ShpWrapCurve hybrid shape WrapCurve feature.

Dim FirstCurvesConstraint As long
Set FirstCurvesConstraint = ShpWrapCurve.FirstCurvesConstraint
Return type:

int

get_curves(i_position: int, o_reference_curve: Reference, o_target_curve: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetCurves(long iPosition,
Reference oReferenceCurve,
Reference oTargetCurve)

Returns a curve from the WrapCurve.

Parameters:

iPosition
The position of the curves in the list of curves.
oReferenceCurve
the reference curve.
oTargetCurve
the target curve.
Legal values: can be egal to Nothing. In this case, the associated
ref curve will be fixed.

Example:
This example retrieves in WrapCurveRefCurve the first reference
curve of the ShpWrapCurve hybrid shape WrapCurve feature and retrieves in
WrapCurveTargCurve the first target curve of the ShpWrapCurve hybrid shape
WrapCurve feature.

Dim WrapCurveRefCurve As Reference
Dim WrapCurveTargCurve As Reference
ShpWrapCurve.GetCurve(2)
Parameters:
Return type:

None

get_number_of_curves() → int

Note

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

Returns the number of couples of curves of the WrapCurve.

Returns:
The number of couples of curves
Legal values: positive or null.

Example:
This example retrieves in NumberOfCurves the number of couples of curves of
the ShpWrapCurve hybrid shape WrapCurve feature.

NumberOfCurves = ShpWrapCurve.GetNumberOfCurves(2)
Return type:

int

get_reference_direction(o_direction_type: int, o_direction: HybridShapeDirection) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetReferenceDirection(long oDirectionType,
HybridShapeDirection oDirection)

Gets the reference direction projection of the wrap curve
feature.

Parameters:

oDirectionType
type of direction.
Legal values: 1 = reference direction is computed, and 2 = user direction.
oDirection
curve to be added as a direction, if oDirectionType = 2.
Example:
This example retrieves in RefDirection the reference direction of
the ShpWrapCurve hybrid shape WrapCurve feature and in RefDirectionType the
reference direction of the ShpWrapCurve hybrid shape
WrapCurve

Dim RefDirectionType As long
Dim RefDirection As CATIAHybridShapeDirection
ShpWrapCurve.SetReferenceDirection (RefDirectionType,
RefDirection)
Parameters:
Return type:

None

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

Note

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

Returns the reference spine of the wrap curve feature.

Parameters:

oSpineType
type of spine.
Legal values: 1 = Reference Spine is equal to the first reference curve, and
2 = user spine.
oSpine
curve to be added as a spine, if iSpineType = 2.

Example:
This example retrieves in RefSpine the reference spine of the
ShpWrapCurve hybrid shape WrapCurve feature and in RefSpineType the reference
spine type.

Dim RefSpineType As long
Dim RefSpine As Reference
ShpWrapCurve.GetReferenceSpine (RefSpineType,
RefSpine)
Parameters:

  • o_spine_type (int) –

  • o_spine (Reference) –

Return type:

None

insert_curves(i_position: int, i_reference_curve: Reference, i_target_curve: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub InsertCurves(long iPosition,
Reference iReferenceCurve,
Reference iTargetCurve)

Inserts a couple of reference curve and target curve to the wrap
curve.

Parameters:

iPosition
The position of the curves in the list of curves.
Legal values: 0 for the end of the list, or positive and not null.

iReferenceCurve
the reference curve.
Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
iTargetCurve
the target curve.
Sub-element(s) supported (see Boundary object): TriDimFeatEdge and
BiDimFeatEdge.

Example:
This example sets the RefCurveForWrapCurve curve and the
TargCurveForWrapCurve curve at the end of the list to the ShpWrapCurve hybrid
shape WrapCurve feature.

ShpWrapCurve.InsertCurves (0, RefCurveForWrapCurve,
TargCurveForWrapCurve)
Parameters:
Return type:

None

insert_reference_curve(i_position: int, i_reference_curve: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub InsertReferenceCurve(long iPosition,
Reference iReferenceCurve)

Inserts a of reference curve to the wrap curve.

Parameters:

iPosition
The position of the curves in the list of curves.
Legal values: 0 for the end of the list, or positive and not null.

iReferenceCurve
the reference curve.
Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.
Example:
This example sets the RefCurveForWrapCurve curve at the end of the list
to the ShpWrapCurve hybrid shape WrapCurve feature.

ShpWrapCurve.InsertCurves (0, RefCurveForWrapCurve)
Parameters:

  • i_position (int) –

  • i_reference_curve (Reference) –

Return type:

None

property last_curves_constraint: int

Note

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

Returns or sets constraint at last curves of the
WrapCurve.
Legal values:
1 = no constraint,
2 = Deformed surface will have the same tangency and the the same curvatureas the original
surface at last curves.

Example:
This example retrieves in LastCurvesConstraint the constraint at last
curves of the ShpWrapCurve hybrid shape WrapCurve feature.

Dim LastCurvesConstraint As long
Set LastCurvesConstraint = ShpWrapCurve.LastCurvesConstraint
Return type:

int

remove_curves(i_position: int) → None

Note

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

Removes a couple of reference curve and target curve from the
WrapCurve.

Parameters:

iPosition
The position of the curves in the list of curves.
Legal values: positive, not null and lower to numberOfCurves


Example:
This example removes the first couple of reference curve and target
curve of the ShpWrapCurve hybrid shape WrapCurve
feature.

ShpWrapCurve.RemoveCurves (1)
Parameters:

i_position (int) –

Return type:

None

set_reference_direction(i_direction: HybridShapeDirection) → None

Note

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

Sets the reference direction projection to the wrap curve
feature.

Parameters:

iDirection
curve to be added as a direction, if iDirectionType = 2.
Example:
This example sets the RefDirection curve as the reference direction
of the ShpWrapCurve hybrid shape WrapCurve
feature.

ShpWrapCurve.SetReferenceDirection RefDirection
Parameters:

i_direction (HybridShapeDirection) –

Return type:

None

set_reference_spine(i_spine: Reference) → None

Note

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

Sets the reference spine to the wrap curve feature.

Parameters:

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

Boundary object): TriDimFeatEdge, BiDimFeatEdge.

Example:
This example sets the Curve10 curve as the reference Spine of the
ShpWrapCurve hybrid shape WrapCurve feature.

ShpWrapCurve.SetReferenceSpine Curve10
Parameters:

i_spine (Reference) –

Return type:

None

property surface: Reference

Note

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

Returns or sets the surface to deform of the WrapCurve.
Sub-element(s) supported (see Boundary object): Face.

Example:
This example retrieves in SurfaceToDeform the surface to deform of the
ShpWrapCurve hybrid shape WrapCurve feature.

SurfaceToDeform = ShpWrapCurve.Surface
Return type:

Reference