pycatia.hybrid_shape_interfaces.hybrid_shape_extract_multi

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_extract_multi.HybridShapeExtractMulti(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

HybridShapeExtractMulti

Represents the hybrid shape ExtractMulti feature object.

Role: To access the data of the hybrid shape ExtractMulti feature

object.

Use the CATIAHybridShapeFactory to create a HybridShapeExtractMulti

object.

See also:

HybridShapeFactory.AddNewExtractMulti

add_constraint(i_constraint: Reference, i_type: int, i_complementaire: bool, i_is_federated: bool, i_crvtre_thsld: float, i_pos: int) → None

Note

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

o Sub AddConstraint(Reference iConstraint,

long iType,

boolean iComplementaire,

boolean iIsFederated,

double iCrvtreThsld,

long iPos)

Deprecated:

V5R16 CATIAHybridShapeExtractMulti#AddConstraintTolerant Adds a

constraint to the list of Extracted Elements.

Parameters:

iConstraint

The constraint to add.

iType

the type of propagation for the ExtractMulti.

iComplementaire

the Complementary flag checked/unchecked for for the constraint.

iIsFederated

the Federated flag checked/unchecked for the constraint.

iCrvtreThsld

the CurvatureThreshold for the constraint.

iPos

The position at which the element is to be added in the list of

constraints.

Example:

This example adds a body in the list of constraints at

specified position with the type of propagation, the Federated flag and the

CurvatureThreshold of the HybShpExtractMulti hybrid shape

ExtractMulti.

Dim iType as long

Dim iComplementaire as boolean

Dim iIsFederated as boolean

Dim iCrvtreThsld as double

HybShpExtractMulti.AddConstraint iCst iType iComplementaire

iIsFederated iCrvtreThsld 1

Parameters:

• i_constraint (Reference) –

• i_type (int) –

• i_complementaire (bool) –

• i_is_federated (bool) –

• i_crvtre_thsld (float) –

• i_pos (int) –

Return type:

None

add_constraint_tolerant(i_constraint: Reference, i_type: int, i_complementaire: bool, i_is_federated: bool, i_distre_thsld: float, i_angtre_thsld: float, i_crvtre_thsld: float, i_pos: int) → None

Note

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

o Sub AddConstraintTolerant(Reference iConstraint,

long iType,

boolean iComplementaire,

boolean iIsFederated,

double iDistreThsld,

double iAngtreThsld,

double iCrvtreThsld,

long iPos)

Adds a constraint to the list of Extracted Elements.

Parameters:

iConstraint

The constraint to add.

iType

the type of propagation for the ExtractMulti.

iComplementaire

the Complementary flag checked/unchecked for for the constraint.

iIsFederated

the Federated flag checked/unchecked for the constraint.

iDistreThsld

the DistanceThreshold for the constraint.

iAngtreThsld

the AngularThreshold for the constraint.

iCrvtreThsld

the CurvatureThreshold for the constraint.

iPos

The position at which the element is to be added in the list of

constraints.

Example:

This example adds a body in the list of constraints at

specified position with the type of propagation, the Federated flag and the

CurvatureThreshold of the HybShpExtractMulti hybrid shape

ExtractMulti.

Dim iType as long

Dim iComplementaire as boolean

Dim iIsFederated as boolean

Dim iDistreThsld as double

Dim iAngtreThsld as double

Dim iCrvtreThsld as double

HybShpExtractMulti.AddConstraintTolerant iCst iType

iComplementaire iIsFederated iCrvtreThsld 1

Parameters:

• i_constraint (Reference) –

• i_type (int) –

• i_complementaire (bool) –

• i_is_federated (bool) –

• i_distre_thsld (float) –

• i_angtre_thsld (float) –

• i_crvtre_thsld (float) –

• i_pos (int) –

Return type:

None

get_angular_threshold(i_pos: int) → float

Note

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

o Func GetAngularThreshold(long iPos) As double

Returns the AngularThreshold of the list of constraints at specified

position.

Example:

This example retrieves the AngularThreshold in the list of constraints

at specified position of the hybShpExtractMulti in

AngularThH.

Dim oAngtreThsld as double

AngularThH = HybShpExtractMulti.GetAngularThreshold(1)

Parameters:

i_pos (int) –

Return type:

float

get_angular_threshold_activity(i_pos: int) → bool

Note

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

o Func GetAngularThresholdActivity(long iPos) As boolean

Returns the AngularThresholdActivity of the list of constraints at

specified position.

Example:

This example retrieves the AngularThresholdActivity of the list of

constraints at specified position of the hybShpExtractMulti in AngularActivity

.

Dim oAngtreThsldActivity as boolean

oAngtreThsldActivity = HybShpExtractMulti.GetAngularThresholdActivity (1)

Parameters:

i_pos (int) –

Return type:

bool

get_complementary_extract_multi(i_pos: int) → bool

Note

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

o Func GetComplementaryExtractMulti(long iPos) As boolean

Returns the Complementary flag checked/unchecked of the list of constraints

at specified position.

Example:

This example retrieves the Complementary flag in the list of

constraints at specified position of the hybShpExtractMulti in

Complementaire.

Dim oComplementaire as boolean

oComplementaire = HybShpExtractMulti.GetComplementaryExtractMulti(1)

Parameters:

i_pos (int) –

Return type:

bool

get_curvature_threshold(i_pos: int) → float

Note

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

o Func GetCurvatureThreshold(long iPos) As double

Returns the CurvatureThreshold of the list of constraints at specified

position.

Example:

This example retrieves the CurvatureThreshold in the list of

constraints at specified position of the hybShpExtractMulti in

CurvatureThH.

Dim oCrvtreThsld as double

CurvatureThH = HybShpExtractMulti.GetCurvatureThreshold(1)

Parameters:

i_pos (int) –

Return type:

float

get_curvature_threshold_activity(i_pos: int) → bool

Note

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

o Func GetCurvatureThresholdActivity(long iPos) As boolean

Returns the CurvatureThresholdActivity of the list of constraints at

specified position.

Example:

This example retrieves the CurvatureThresholdActivity of the list of

constraints at specified position of the hybShpExtractMulti in

CurvatureActivity .

Dim oCrvtreThsldActivity as boolean

oCrvtreThsldActivity = HybShpExtractMulti.GetCurvatureThresholdActivity (1)

Parameters:

i_pos (int) –

Return type:

bool

get_distance_threshold(i_pos: int) → float

Note

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

o Func GetDistanceThreshold(long iPos) As double

Returns the DistanceThreshold of the list of constraints at specified

position.

Example:

This example retrieves the DistanceThreshold in the list of constraints

at specified position of the hybShpExtractMulti in

DistanceThH.

Dim oDistreThsld as double

DistanceThH = HybShpExtractMulti.GetDistanceThreshold(1)

Parameters:

i_pos (int) –

Return type:

float

get_distance_threshold_activity(i_pos: int) → bool

Note

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

o Func GetDistanceThresholdActivity(long iPos) As boolean

Returns the DistanceThresholdActivity of the list of constraints at

specified position.

Example:

This example retrieves the DistanceThresholdActivity of the list of

constraints at specified position of the hybShpExtractMulti in DistanceActivity

.

Dim oDistreThsldActivity as boolean

oDistreThsldActivity = HybShpExtractMulti.GetDistanceThresholdActivity (1)

Parameters:

i_pos (int) –

Return type:

bool

get_element(i_pos: int) → Reference

Note

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

o Func GetElement(long iPos) As Reference

Returns the sub element used as init for the propagation.

Example:

This example retrieves the sub element in the list of constraints at

specified position of the hybShpExtractMulti in Elem.

Dim oElem as CATIAReference

oElem = HybShpExtractMulti.GetElement(1)

See also:

HybridShapeFactory

Parameters:

i_pos (int) –

Return type:

Reference

get_is_federated(i_pos: int) → bool

Note

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

o Func GetIsFederated(long iPos) As boolean

Returns the IsFederated flag checked/unchecked of the list of constraints

at specified position.

Example:

This example retrieves the federated flag in the list of constraints at

specified position of the hybShpExtractMulti in

IsFederated.

Dim oIsFederated as boolean

oIsFederated = HybShpExtractMulti.GetIsFederated(1)

Parameters:

i_pos (int) –

Return type:

bool

get_list_of_constraints(o_list_of_extracted_constraints: tuple) → None

Note

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

o Sub GetListOfConstraints(CATSafeArrayVariant

oListOfExtractedConstraints)

Returns the list of Extracted Elements.

Parameters:

oListOfExtractedConstraints

The list of constraints. It is returned as an array of

nbconstraints in SafeArrayVariant.

Example:

This example returns the list of constraints of the

HybShpExtractMulti hybrid shape ExtractMulti.

Dim oListOfExtractedConstraints as CATSafeArrayVariant

HybShpExtractMulti.GetListOfConstraints

(oListOfExtractedConstraints)

Note: You can access each constraint as

follows:

1 is in oListOfExtractedConstraints(0)

2 is in oListOfExtractedConstraints(1)

nbconstraints is in

oListOfExtractedConstraints(nbconstraints-1)

Parameters:

o_list_of_extracted_constraints (tuple) –

Return type:

None

get_nb_constraints(o_nb_constraints: int) → None

Note

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

o Sub GetNbConstraints(long oNbConstraints)

Returns number of constraints in the list of Extracted

Elements.

Parameters:

oNbConstraints

number of constraints in the list of Extracted

Elements.

Example:

This example returns number of constraints in the list of

constraints of the HybShpExtractMulti hybrid shape

ExtractMulti.

Dim oNbConstraints as long

HybShpExtractMulti.GetNbConstraints (oNbConstraints )

Parameters:

o_nb_constraints (int) –

Return type:

None

get_propagation_type(i_pos: int) → int

Note

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

o Func GetPropagationType(long iPos) As long

Returns the type of propagation of the list of constraints at specified

position.

The propagation types for the ExtractMulti can have the following

values:

1 for extraction propagation in point continuity

2 for extraction propagation in tangent continuity

3 for extraction without propagation

4 for extraction propagation in curvature continuity

Example:

This example retrieves the PropagationType in the list of constraints

at specified position of the hybShpExtractMulti in

TypePropag.

Dim oTypePropag as long

oTypePropag = HybShpExtractMulti.GetPropagationType(1)

Parameters:

i_pos (int) –

Return type:

int

get_support(i_pos: int) → Reference

Note

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

o Func GetSupport(long iPos) As Reference

Returns the support of the list of constraints at specified

position.

Parameters:

oSupport

The support.

Parameters:

i_pos (int) –

Return type:

Reference

remove_element(i_position: int) → None

Note

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

o Sub RemoveElement(long iPosition)

Removes the body to be extracted from the list of constraints at specified

position.

Parameters:

iPosition

Position at which the body is to be removed

Example:

This example removes the body from the list of constraints at

specified position of the HybShpExtractMulti hybrid shape

ExtractMulti.

HybShpExtractMulti.RemoveElement 1

Parameters:

i_position (int) –

Return type:

None

replace_element(i_extract_to_replace: Reference, i_new_extract: Reference, i_pos: int) → None

Note

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

o Sub ReplaceElement(Reference iExtractToReplace,

Reference iNewExtract,

long iPos)

Replaces an element to extract in the list of constraints at specified

position.

Parameters:

iExtractToReplace

The element to replace.

iNewExtract

The new element.

iPos

The position at which the element is to be replaced in the list of

constraints.

Example:

This example replaces the body from the list of constraints at

specified position of the HybShpExtractMulti hybrid shape

ExtractMulti.

Dim RefToRep as CATIAReference

Dim RefNewExtract as CATIAReference

HybShpExtractMulti.ReplaceElement RefToRep RefNewExtract 1

Parameters:

• i_extract_to_replace (Reference) –

• i_new_extract (Reference) –

• i_pos (int) –

Return type:

None

set_angular_threshold(i_pos: int, i_angtre_thsld: float) → None

Note

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

o Sub SetAngularThreshold(long iPos,

double iAngtreThsld)

Sets the AngularThreshold in the list of constraints at specified

position.

Example:

This example sets the AngularThreshold of the list of constraints at

specified position of the hybShpExtractMulti in

AngularThH.

Dim iAngtreThsld as double

HybShpExtractMulti.SetAngularThreshold 1 iAngtreThsld

Parameters:

• i_pos (int) –

• i_angtre_thsld (float) –

Return type:

None

set_angular_threshold_activity(i_pos: int, i_angtre_thsld_activity: bool) → None

Note

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

o Sub SetAngularThresholdActivity(long iPos,

boolean iAngtreThsldActivity)

Sets the AngularThresholdActivity in the list of constraints at specified

position.

Example:

This example sets the AngularThresholdActivity in the list of

constraints at specified position of the hybShpExtractMulti in AngularActivity

.

Dim iAngtreThsldActivity as boolean

iAngtreThsldActivity = TRUE

HybShpExtractMulti.SetAngularThresholdActivity 1 iAngtreThsldActivity

Parameters:

• i_pos (int) –

• i_angtre_thsld_activity (bool) –

Return type:

None

set_complementary_extract_multi(i_pos: int, i_complementaire: bool) → None

Note

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

o Sub SetComplementaryExtractMulti(long iPos,

boolean iComplementaire)

Sets the Complementary flag checked/unchecked in the list of constraints at

specified position.

Example:

This example sets the Complementary flag of the list of constraints at

specified position of the hybShpExtractMulti in

Complementaire.

Dim iComplementaire as boolean

iComplementaire = TRUE

HybShpExtractMulti.SetComplementaryExtractMulti 1 iComplementaire

Parameters:

• i_pos (int) –

• i_complementaire (bool) –

Return type:

None

set_curvature_threshold(i_pos: int, i_crvtre_thsld: float) → None

Note

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

o Sub SetCurvatureThreshold(long iPos,

double iCrvtreThsld)

Sets the CurvatureThreshold in the list of constraints at specified

position.

Example:

This example sets the CurvatureThreshold of the list of constraints at

specified position of the hybShpExtractMulti in

CurvatureThH.

Dim iCrvtreThsld as double

HybShpExtractMulti.SetCurvatureThreshold 1 iCrvtreThsld

Parameters:

• i_pos (int) –

• i_crvtre_thsld (float) –

Return type:

None

set_curvature_threshold_activity(i_pos: int, i_crvtre_thsld_activity: bool) → None

Note

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

o Sub SetCurvatureThresholdActivity(long iPos,

boolean iCrvtreThsldActivity)

Sets the CurvatureThresholdActivity in the list of constraints at specified

position.

Example:

This example sets the CurvatureThresholdActivity in the list of

constraints at specified position of the hybShpExtractMulti in

CurvatureActivity .

Dim iCrvtreThsldActivity as boolean

iCrvtreThsldActivity = TRUE

HybShpExtractMulti.SetCurvatureThresholdActivity 1

iCrvtreThsldActivity

Parameters:

• i_pos (int) –

• i_crvtre_thsld_activity (bool) –

Return type:

None

set_distance_threshold(i_pos: int, i_distre_thsld: float) → None

Note

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

o Sub SetDistanceThreshold(long iPos,

double iDistreThsld)

Sets the DistanceThreshold in the list of constraints at specified

position.

Example:

This example sets the DistanceThreshold of the list of constraints at

specified position of the hybShpExtractMulti in

DistanceThH.

Dim iDistreThsld as double

HybShpExtractMulti.SetDistanceThreshold 1 iDistreThsld

Parameters:

• i_pos (int) –

• i_distre_thsld (float) –

Return type:

None

set_distance_threshold_activity(i_pos: int, i_distre_thsld_activity: bool) → None

Note

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

o Sub SetDistanceThresholdActivity(long iPos,

boolean iDistreThsldActivity)

Sets the DistanceThresholdActivity in the list of constraints at specified

position.

Example:

This example sets the DistanceThresholdActivity in the list of

constraints at specified position of the hybShpExtractMulti in DistanceActivity

.

Dim iDistreThsldActivity as boolean

iDistreThsldActivity = TRUE

HybShpExtractMulti.SetDistanceThresholdActivity 1

iDistreThsldActivity

Parameters:

• i_pos (int) –

• i_distre_thsld_activity (bool) –

Return type:

None

set_element(i_pos: int, i_elem: Reference) → None

Note

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

o Sub SetElement(long iPos,

Reference iElem)

Sets the sub element used as init for the propagation.

Example:

This example sets the sub element in the list of constraints at

specified position of the hybShpExtractMulti in Elem.

Dim iPos as long

Dim iElem as CATIAReference

HybShpExtractMulti.SetElement 1 iElem

See also:

HybridShapeFactory

Parameters:

• i_pos (int) –

• i_elem (Reference) –

Return type:

None

set_is_federated(i_pos: int, i_is_federated: bool) → None

Note

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

o Sub SetIsFederated(long iPos,

boolean iIsFederated)

Sets the IsFederated flag checked/unchecked in the list of constraints at

specified position.

Example:

This example sets the federated flag in the list of constraints at

specified position of the hybShpExtractMulti in

IsFederated.

Dim iIsFederated as boolean

iIsFederated = TRUE

HybShpExtractMulti.SetIsFederated 1 iIsFederated

Parameters:

• i_pos (int) –

• i_is_federated (bool) –

Return type:

None

set_propagation_type(i_pos: int, i_type_propag: int) → None

Note

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

o Sub SetPropagationType(long iPos,

long iTypePropag)

Sets the type of propagation for the ExtractMulti in the list of

constraints at specified position.

The propagation types for the ExtractMulti can have the following

values:

1 for extraction propagation in point continuity

2 for extraction propagation in tangent continuity

3 for extraction without propagation

4 for extraction propagation in curvature continuity

Example:

This example sets the PropagationType of the list of constraints at

specified position of the hybShpExtractMulti in

TypePropag.

Dim iTypePropag as long

iTypePropag = 1

HybShpExtractMulti.SetPropagationType 1 iTypePropag

Parameters:

• i_pos (int) –

• i_type_propag (int) –

Return type:

None

set_support(i_pos: int, i_support: Reference) → None

Note

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

o Sub SetSupport(long iPos,

Reference iSupport)

Sets the support of the list of constraints at specified

position.

Parameters:

oSupport

The support.

Parameters:

• i_pos (int) –

• i_support (Reference) –

Return type:

None