pycatia.hybrid_shape_interfaces.hybrid_shape_split

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_split.HybridShapeSplit(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
HybridShapeSplit

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

The element to be cut (surface or curve)
The cutting element ( surface, curve or point)
An orientation to specify which side has to be kept

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 HybridShapeFeature
object.

See also:
HybridShapeFactory
add_cutting_elem(i_elem: Reference, i_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddCuttingElem(Reference iElem,
long iOrientation)

Adds a cutting feature.

Parameters:

iElem
cutting feature
iOrientation
Orientation iOrientation
1 : SameOrientation
-1 : InvertOrientation
2 : KoOrientation
Parameters:

  • i_elem (Reference) –

  • i_orientation (int) –

Return type:

None

add_element_to_keep(i_element: Reference) → None

Note

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

Adds an element to specifications. This element will be
kept.

Parameters:

iElement
Element to keep.
Parameters:

i_element (Reference) –

Return type:

None

add_element_to_remove(i_element: Reference) → None

Note

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

Adds an element to specifications. This element will be
removed.

Parameters:

iElement
Element to remove.
Parameters:

i_element (Reference) –

Return type:

None

property automatic_extrapolation_mode: bool

Note

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

Gets or sets the automatic extrapolation mode status. AutomaticExtrapolationMode =
TRUE : Automatic extrapolation mode is on. =
FALSE : Automatic extrapolation mode is off.

This example retrieves in AutoExtrapolMode the automatic extrapolation mode status for the Split
hybrid shape feature.

Dim AutoExtrapolMode As boolean
AutoExtrapolMode = Split.AutomaticExtrapolationMode
Return type:

bool

property both_sides_mode: bool

Note

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

Gets or sets both sides computation mode.
BothSidesMode
TRUE : Both sides are computed.
FALSE : Both sides are not computed.

This example retrieves in BothSides the both sides computation mode for the Split hybrid shape
feature.

Dim BothSides As boolean
BothSides = Split.BothSidesMode
Return type:

bool

property cutting_elem: Reference

Note

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

Returns or sets the cutting element.
Sub-element(s) supported (see Boundary object): Face, TriDimFeatEdge,
BiDimFeatEdge or Vertex.

Example:
This example retrieves in CuttingElement the cutting element for the
Split hybrid shape feature.

Dim CuttingElement As Reference
Set CuttingElement = Split.CuttingElem
Return type:

Reference

property elem_to_cut: Reference

Note

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

Returns or sets the element to cut.

Example:
This example retrieves in Element the element to cut for the Split
hybrid shape feature.

Dim Element As Reference
Set Element = Split.ElemToCut
Return type:

Reference

property extrapolation_type: int

Note

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

Gets or sets the extrapolation type.
ExtrapolationType = CATGSMExtrapolationType_None(0). =
CATGSMExtrapolationType_Tangent(1). =
CATGSMExtrapolationType_Curvature(2).

This example retrieves in ExtrapolateType the extrapolation type for the Split hybrid shape
feature.
Return type:

int

get_cutting_elem(i_rank: int) → Reference

Note

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

Gets the cutting feature at a given index (a point, a curve or a
surface).

Parameters:

oElem
cutting feature
iRank
Index of one of the cutting features
Parameters:

i_rank (int) –

Return type:

Reference

get_intersection(i_rank: int) → Reference

Note

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

Gets the intersection at a given index.

Parameters:

oElem
Intersection
iRank
Index of one of the intersection features
Parameters:

i_rank (int) –

Return type:

Reference

get_kept_elem(i_rank: int) → Reference

Note

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

Gets the kept feature at a given index.

Parameters:

oElem
Kept feature
iRank
Index of one of the kept features
Parameters:

i_rank (int) –

Return type:

Reference

get_nb_cutting_elem() → int

Note

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

Gets the number of cutting features.

Parameters:

oNbCuttingElem
Number of cutting features
Return type:

int

get_nb_elements_to_keep() → int

Note

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

Gets the number of elements to keep.

Parameters:

oNbElementsToKeep
Number of elements to keep
Return type:

int

get_nb_elements_to_remove() → int

Note

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

Gets the number of elements to remove.

Parameters:

oNbElementsToRemove
Number of elements to remove
Return type:

int

get_orientation(i_rank: int) → int

Note

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

Gets Orientation used to compute the split.

Parameters:

oOrientation
Orientation
iRank
index of the cutting feature
oOrientation
1 : SameOrientation
-1 : InvertOrientation
2 : KoOrientation
Parameters:

i_rank (int) –

Return type:

int

get_other_side() → Reference

Note

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

Gets the other side.

Parameters:

oElem
Other side
Return type:

Reference

get_removed_elem(i_rank: int) → Reference

Note

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

Gets the removed feature at a given index.

Parameters:

oElem
Removed feature
iRank
Index of one of the removed features
Parameters:

i_rank (int) –

Return type:

Reference

property intersection_computation: bool

Note

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

Gets or sets Intersection computation mode.
IntersectionComputation =
TRUE : Intersection is computed. =
FALSE : Intersection is not computed.

This example retrieves in Intersection the Intersection computation mode for the Split hybrid
shape feature.

Dim Intersection As boolean
Intersection = Split.IntersectionComputation
Return type:

bool

invert_orientation() → None

Note

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

Inverts the orientation used to compute the split.
Return type:

None

property orientation: int

Note

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

Returns or sets the orientation used to compute the split.
Role:
Orientation specifies kept parts of cut feature.

When splitting a surface by a surface :
- If orientation value is 1: kept parts are specified by the “natural”
normal to the cutting feature
- If orientation value -1: kept parts are specified by the inverse of the
“natural” normal to the cutting feature

When splitting a surface by a curve :
- If orientation value is 1:
kept parts are specified by the result of the cross product : normal(surface)^tangent(curve)
- If orientation value is -1:
Kept parts are specified by the inverse of the result of the cross product :
normal(surface)^tangent(curve)

When splitting a curve by a point or a curve (without support specified)
:
- If orientation value is 1: Kept parts are from beginning of the curve to
the first intersection,
and, if there is one, from the second to the third intersection and so on
until the end of the curve.
- If orientation value is -1: Kept parts are from the first intersection to
the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end
of the curve.

When splitting a curve on support:
- If orientation value is 1:
Kept parts are specified by the result of the cross product :
normal(support surface)^tangent(cutting curve)
- If orientation value is -1:
Kept parts are specified by the inverse of the result of the cross product :
normal(support surface)^tangent(cutting curve)

When splitting a curve by a surface:
- If orientation value is 1: Kept parts are specified by the inverse of the
normal to the surface
- If orientation value is -1: Kept parts are specified by the normal to the
surface

Example
This example retrieves in OrientValue the orientation value for the
Split hybrid shape feature.

Dim OrientValue As long
Set OrientValue = Split.Orientation
Return type:

int

remove_cutting_elem(i_elem: Reference) → None

Note

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

Removes a cutting feature.

Parameters:

iElem
cutting feature
Parameters:

i_elem (Reference) –

Return type:

None

remove_element_to_keep(i_rank: int) → None

Note

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

Removes an element from specifications.

Parameters:

iRank
Index of the kept element.
Parameters:

i_rank (int) –

Return type:

None

remove_element_to_remove(i_rank: int) → None

Note

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

Removes an element from specifications.

Parameters:

iRank
Index of the removed element.
Parameters:

i_rank (int) –

Return type:

None

set_orientation(i_rank: int, i_orientation: int) → None

Note

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

Sets the orientation used to compute the split.

Parameters:

iOrientation
Orientation
iRank
index of the cutting feature
iOrientation
1 : SameOrientation
-1 : InvertOrientation
2 : KoOrientation
Parameters:

  • i_rank (int) –

  • i_orientation (int) –

Return type:

None

property support: Reference

Note

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

Returns or sets the support element.
This support element may not exist.
Sub-element(s) supported (see Boundary object): Face.

Example:
This example retrieves in Element the support element for the Split
hybrid shape feature.

Dim Element As Reference
Set Element = Split.Support
Return type:

Reference

property volume_result: int

Note

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

Returns or sets the Result Type.
Result type:

: 0 -> Surface
: 1 -> Volume
, The resultant split will be volume. If input is element to cut is
volume.


Note: Setting volume result requires GSO License.

Example: This example retrieves in ResultType the result type for the Split
hybrid shape feature.

Dim RType As long
Set RType = Split.ResultType
Return type:

int