pycatia.hybrid_shape_interfaces.hybrid_shape_healing

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_healing.HybridShapeHealing(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

HybridShapeHealing

Represents the hybrid shape healing feature object.

Role: Allows to access to the body to process for a Healing feature. Use the

CATIAHybridShapeFactory to create HybridShapeFeature object.

See also:

HybridShapeFactory.AddNewHealing

add_body_to_heal(i_body: Reference) → None

Note

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

o Sub AddBodyToHeal(Reference iBody)

Adds the body to be healed to the list.

Parameters:

Body

Reference to the body to be added to the list.

Example:

This example adds the body to the list. of the HybShpHealing

hybrid shape healing.

HybShpHealing.AddBodyToHeal refBody

Parameters:

i_body (Reference) –

Return type:

None

add_edge_to_keep_sharp(i_edge: Reference) → None

Note

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

o Sub AddEdgeToKeepSharp(Reference iEdge)

Adds the edge to be kept sharp while healing, to the list.

Parameters:

Edge

Reference to the Edge to be kept sharp

Example:

This example adds the Edge to the list of Edges to be kept

sharp. of the HybShpHealing hybrid shape

healing.

HybShpHealing.AddEdgeToKeepSharp refEdge

Parameters:

i_edge (Reference) –

Return type:

None

add_elements_to_freeze(i_element: Reference) → None

Note

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

o Sub AddElementsToFreeze(Reference iElement)

Adds the body to be freezed while healing, to the list.

Parameters:

Element

Reference to the element to be freezed.

Example:

This example adds the body to the list of bodies to be freezed.

of the HybShpHealing hybrid shape healing.

HybShpHealing.AddElementsToFreeze refElement

Parameters:

i_element (Reference) –

Return type:

None

property canonic_free_mode: int

Note

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

o Property CanonicFreeMode(long iMode)

Returns or sets the Canonic Free Mode of the healing.

Parameters:

oMode

(For get_CanonicFreeMode) Long parameter for retrieving the

CanonicFreeMode.

iMode

(For set_CanonicFreeMode) Long parameter for settingthe

CanonicFreeMode.

Example:

This example sets and retrieves the CanonicFreeMode of the

healing of the HybShpHealing hybrid shape

healing.

Dim HybShpHealMode As Long

HybShpHealMode = ..set appropriate value

HybShpHealing.CanonicFreeMode = HybShpHealMode

HybShpHealCont = HybShpHealing.CanonicFreeMode

Return type:

int

property continuity: int

Note

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

o Property Continuity(long iContinuity)

Returns or sets the continuity type of the healing.

Parameters:

Continuity

Parameter for the continuity. Legal values are 0 and

1

Example:

This example sets and retrieves the Continuity of the healing

of the HybShpHealing hybrid shape healing.

Dim HybShpHealCont As Long

HybShpHealCont = ..set appropriate value

HybShpHealing.Continuity = HybShpHealCont

HybShpHealCont = HybShpHealing.Continuity

Return type:

False

property distance_objective: Length

Note

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

o Property DistanceObjective() As Length (Read Only)

Returns the Distance Objective of the healing.

Parameters:

DistanceObjective

Length parameter for retrieving the Distance

Objective.

Example:

This example retrieves the DistanceObjective of the healing of

the HybShpHealing hybrid shape healing.

Dim HybShpHealDistObjective As Length

Set HybShpHealDistObjective = HybShpHealing.DistanceObjective

Return type:

Length

get_body_to_heal(i_position: int) → Reference

Note

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

o Func GetBodyToHeal(long iPosition) As Reference

Returns the body to be healed from the list at specified

position.

Parameters:

Position

Position at which the body is to be obtained

Body

Reference to the body obtained at specified

position.

Example:

This example gets the body from the list by specifying the

position. of the HybShpHealing hybrid shape

healing.

set refBody = HybShpHealing.GetBodyToHeal 1

Parameters:

i_position (int) –

Return type:

Reference

get_edge_to_keep_sharp(i_position: int) → Reference

Note

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

o Func GetEdgeToKeepSharp(long iPosition) As Reference

Returns the edge to be kept sharp from the list at specified

position.

Parameters:

Position

Position at which the element is to be obtained

Edge

Reference to the element obtained at specified

position.

Example:

This example gets the Edge from the list of Edges to be kept

sharp by specifying the position of the HybShpHealing hybrid shape

healing.

set refEdge = HybShpHealing.GetEdgeToKeepSharp 1

Parameters:

i_position (int) –

Return type:

Reference

get_element_to_freeze(i_position: int) → Reference

Note

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

o Func GetElementToFreeze(long iPosition) As Reference

Returns the element to be freezed from the list at specified

position.

Parameters:

Position

Position at which the element is to be obtained

Element

Reference to the element obtained at specified

position.

Example:

This example gets the element from the list of bodies to be

freezed by specifying the position of the HybShpHealing hybrid shape

healing.

set refElement = HybShpHealing.GetElementToFreeze 1

Parameters:

i_position (int) –

Return type:

Reference

property merging_distance: Length

Note

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

o Property MergingDistance() As Length (Read Only)

Returns the Merging Distance of the healing.

Parameters:

MergingDistance

Length parameter for retrieving the Merging

Distance.

Example:

This example retrieves the MergingDistance of the healing of

the HybShpHealing hybrid shape healing.

Dim HybShpHealMergeDist As Length

Set HybShpHealMergeDist = HybShpHealing.MergingDistance

Return type:

Length

property no_of_bodies_to_heal: int

Note

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

o Property NoOfBodiesToHeal() As long (Read Only)

Returns the number of bodies to heal of the healing.

Parameters:

NumberOfbodies

Number of bodies to heal in the healing.

Example:

This example retrieves the number of bodies to heal of the

HybShpHealing hybrid shape Healing.

Dim NoOfBodiesToHeal As long

NoOfBodiesToHeal = HybShpHealing.NoOfBodiesToHeal

Return type:

int

property no_of_edges_to_keep_sharp: int

Note

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

o Property NoOfEdgesToKeepSharp() As long (Read Only)

Returns the number of edges to keep sharp of the healing.

Parameters:

NumberOfEdges

Number of edges to keep sharp.

Example:

This example retrieves the number of edges to keep sharp of the

HybShpHealing hybrid shape Healing.

Dim NoOfEdges As long

NoOfEdges = HybShpHealing.NoOfEdgesToKeepSharp

Return type:

int

property no_of_elements_to_freeze: int

Note

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

o Property NoOfElementsToFreeze() As long (Read Only)

Returns the number of elements to heal of the healing.

Parameters:

NumberOfElements

Number of elements to freeze in the healing.

Example:

This example retrieves the number of elements to freeze of the

HybShpHealing hybrid shape Healing.

Dim NoOfElementsToFreeze As long

NoOfElementsToFreeze = HybShpHealing.NoOfElementsToFreeze

Return type:

int

remove_body_to_heal(i_position: int) → None

Note

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

o Sub RemoveBodyToHeal(long iPosition)

Removes the body to be healed from the list at specified

position.

Parameters:

iPosition

Position at which the body is to be removed

Example:

This example removes the body from the list at specifying the

position. of the HybShpHealing hybrid shape

healing.

HybShpHealing.RemoveBodyToHeal 1

Parameters:

i_position (int) –

Return type:

None

remove_edge_to_keep_sharp(i_position: int) → None

Note

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

o Sub RemoveEdgeToKeepSharp(long iPosition)

Removes the edge from the list of edges to be kept sharp at specified

position.

Parameters:

iPosition

Position at which the edge is to be removed

Example:

This example removes the edge from the list at specified

position. of the HybShpHealing hybrid shape

healing.

HybShpHealing.RemoveEdgeToKeepSharp 1

Parameters:

i_position (int) –

Return type:

None

remove_element_to_freeze(i_position: int) → None

Note

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

o Sub RemoveElementToFreeze(long iPosition)

Removes the element from the list of elements to be freezed at specified

position.

Parameters:

Position

Position at which the element is to be removed

Example:

This example removes the element from the list at specifying

the position. of the HybShpHealing hybrid shape

healing.

HybShpHealing.RemoveElementToFreeze 1

Parameters:

i_position (int) –

Return type:

None

replace_to_heal_element(i_index: int, i_new_heal: Reference) → None

Note

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

o Sub ReplaceToHealElement(long iIndex,

Reference iNewHeal)

Replaces an element to heal.

Parameters:

iIndex

The position of the element to replace.

iNewHeal

The new element.

Parameters:

• i_index (int) –

• i_new_heal (Reference) –

Return type:

None

set_distance_objective(i_distance_objective: float) → None

Note

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

o Sub SetDistanceObjective(double iDistanceObjective)

Sets the distance objective for healing entity.

Parameters:

DistanceObjective

Parameter containg the value of the distance objective to be

set.

Example:

This example sets the distance objective for the healing of the

HybShpHealing hybrid shape healing.

HybShpHealing.SetDistanceObjective 2.5

Parameters:

i_distance_objective (float) –

Return type:

None

set_merging_distance(i_merging_distance: float) → None

Note

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

o Sub SetMergingDistance(double iMergingDistance)

Sets the Merging distance for healing entity.

Parameters:

MergingDistance

Parameter containg the value of the merging distance to be

set.

Example:

This example sets the merging distance for the healing of the

HybShpHealing hybrid shape healing.

HybShpHealing.SetMergingDistance 2.5

Parameters:

i_merging_distance (float) –

Return type:

None

set_sharpness_angle(i_sharpness_angle: float) → None

Note

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

o Sub SetSharpnessAngle(double iSharpnessAngle)

Sets the Sharpness Angle for healing entity.

Parameters:

SharpnessAngle

Parameter containg the value of the Sharpness Angle to be

set.

Example:

This example sets the Sharpness Angle for the healing of the

HybShpHealing hybrid shape healing.

HybShpHealing.SetSharpnessAngle 2.5

Parameters:

i_sharpness_angle (float) –

Return type:

None

set_tangency_angle(i_tangency_angle: float) → None

Note

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

o Sub SetTangencyAngle(double iTangencyAngle)

Sets the distance objective for healing entity.

Parameters:

TangencyAngle

Parameter containg the value of the Tangency Angle to be

set.

Example:

This example sets the Tangency Angle for the healing of the

HybShpHealing hybrid shape healing.

HybShpHealing.SetTangencyAngle 2.5

Parameters:

i_tangency_angle (float) –

Return type:

None

set_tangency_objective(i_tangency_objective: float) → None

Note

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

o Sub SetTangencyObjective(double iTangencyObjective)

Sets the tangency objective for healing entity.

Parameters:

TangencyObjective

Parameter containg the value of the Tangency Objective to be

set.

Example:

This example sets the Tangency Objective for the healing of the

HybShpHealing hybrid shape healing.

HybShpHealing.SetTangencyObjective 2.5

Parameters:

i_tangency_objective (float) –

Return type:

None

property sharpness_angle: Angle

Note

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

o Property SharpnessAngle() As Angle (Read Only)

Returns the Sharpness Angle of the healing.

Parameters:

SharpnessAngle

Angle parameter for retrieving the Sharpness

Angle.

Example:

This example retrieves the Sharpness Angle of the healing of

the HybShpHealing hybrid shape healing.

Dim HybShpHealSharpnessAngle As Angle

Set HybShpHealSharpnessAngle = HybShpHealing.SharpnessAngle

Return type:

Angle

property tangency_angle: Angle

Note

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

o Property TangencyAngle() As Angle (Read Only)

Returns the Tangency Angle of the healing.

Parameters:

TangencyAngle

Angle parameter for retrieving the TangencyAngle.

Example:

This example retrieves the TangencyAngle of the healing of the

HybShpHealing hybrid shape healing.

Dim HybShpHealTangencyAngle As Angle

Set HybShpHealTangencyAngle = HybShpHealing.TangencyAngle

Return type:

Angle

property tangency_objective: Length

Note

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

o Property TangencyObjective() As Length (Read Only)

Returns the Tangency Objective of the healing.

Parameters:

TangencyObjective

Length parameter for retrieving the Tangency

Objective.

Example:

This example retrieves the TangencyObjective of the healing of

the HybShpHealing hybrid shape healing.

Dim HybShpHealTangencyObjective As Length

Set HybShpHealTangencyObjective = HybShpHealing.TangencyObjective

Return type:

Length