pycatia.hybrid_shape_interfaces.hybrid_shape_unfold

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_unfold.HybridShapeUnfold(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
HybridShapeUnfold

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

The shell to unfold
The edges to tear

Use the CATIAHybridShapeFactory to create a HybridShapeUnfold
object.

See also:
HybridShapeFactory
add_edge_to_tear(i_element: Reference) → None

Note

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

Adds an edge to tear.

Parameters:

iEdge
The edge to tear to add to the hybrid shape feature
object.
Sub-element(s) supported (see

Boundary object): Edge

Examples:
The following example adds the iElement feature object to the
HybridShapeUnfold object.

HybridShapeUnfold.AddEdgeToTear iElement
Parameters:

i_element (Reference) –

Return type:

None

add_element_to_transfer(i_element: Reference, i_type_of_transfer: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddElementToTransfer(Reference iElement,
long iTypeOfTransfer)

Appends an element to transfer.

Parameters:

iElement
Specification to transfer
iTypeOfTransfer
type of tranfer

0= No transfer mode specified
1= Folded to unfolded
2= Unfolded to folded
Parameters:

  • i_element (Reference) –

  • i_type_of_transfer (int) –

Return type:

None

property direction_to_unfold: Reference

Note

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

Returns or sets the direction to unfold.
Return type:

Reference

property edge_to_tear_positioning_orientation: int

Note

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

Returns or sets the positioning orientation when the reference origin is
located on an edge to tear.

0= The orientation is undefined
1= The orientation is the default one
2= The orientation is inversed
Return type:

int

get_edge_to_tear(i_rank: int) → Reference

Note

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

Retrieves an element used by the hybrid shape unfold feature
object.

Parameters:

iRank
The rank of the element to read.

Examples:
The following example gets the oElement feature object of the
HybridShapeUnfold object at the position iRank.

Dim oElement As Reference
Set oElement = HybridShapeUnfold.GetEdgeToTear (iRank).
Parameters:

i_rank (int) –

Return type:

Reference

get_element_to_transfer(i_rank: int, op_element: Reference, o_type_of_transfer: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetElementToTransfer(long iRank,
Reference opElement,
long oTypeOfTransfer)

Gets an element to transfer.

Parameters:

iRank
the position of the specification to get
opElement
Specification to transfer
oTypeOfTransfer
type of tranfer

0= No transfer mode specified
1= Folded to unfolded
2= Unfolded to folded
Parameters:

  • i_rank (int) –

  • op_element (Reference) –

  • o_type_of_transfer (int) –

Return type:

None

property origin_to_unfold: Reference

Note

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

Returns or sets the origin to unfold.
Return type:

Reference

remove_edge_to_tear(i_rank: int) → None

Note

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

Removes an element used by the hybrid shape unfold feature
object.

Parameters:

iRank
The rank of the element to remove.

Examples:
The following example removes the feature object from the
HybridShapeUnfold object at the position iRank.

HybridShapeUnfold.RemoveEdgeToTear iRank.
Parameters:

i_rank (int) –

Return type:

None

remove_element_to_transfer(i_rank: int) → None

Note

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

Remove an elements to transfer.

Parameters:

iRank
the position of the specification to remove
Parameters:

i_rank (int) –

Return type:

None

replace_elements_to_transfer(i_rank: int, i_element: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplaceElementsToTransfer(long iRank,
Reference iElement)

Replace an elements to transfer.

Parameters:

iRank
the position of the specification to replace
iElement
the specification to transfer to append.
Parameters:
Return type:

None

property surface_to_unfold: Reference

Note

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

Returns or sets the surface to unfold.
Sub-element(s) supported (see Boundary object): Face, TriDimFeatEdge and
BiDimFeatEdge.
Return type:

Reference

property surface_type: int

Note

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

Returns or sets the type of surface to unfold.

0= The type of surface is not defined
1= The type of surface is ruled
2= The type of surface is all
Return type:

int

property target_orientation_mode: int

Note

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

Returns or sets the mode for target surface orientation.

0= No axis inversion
1= U inversion axis
2= V inversion axis
3= U inversion axis and V inversion axis
4= U inversion axis and swap U and V axis
5= V inversion axis and swap U and V axis
6= U inversion axis, V inversion axis and swap U and V
axis
7= Swap U and V axis
Return type:

int

property target_plane: Reference

Note

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

Returns or sets the target plane.
Sub-element(s) supported (see Boundary object):
Return type:

Reference