pycatia.hybrid_shape_interfaces.hybrid_shape_fill

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_fill.HybridShapeFill(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
HybridShapeFill

The Fill feature : an Fill is made up of a face to process and one Fill parameter.
add_bound(i_boundary: Reference) → None

Note

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

Adds an boundary to the hybrid shape fill feature object.

Parameters:

iBoundary
The boundary(curve) to be added to the hybrid shape fill feature
object.

Example:
The following example adds the iBoundary curve to the Fill
object.

Fill.AddBound iBoundary
Parameters:

i_boundary (Reference) –

Return type:

None

add_support_at_bound(i_boundary: Reference, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddSupportAtBound(Reference iBoundary,
Reference iSupport)

Inserts the support at specified boundary in the Fill.

Parameters:

iBoundary
Reference of the boundary object to which support has to be added.

iSupport
Reference of the support object to be added.

Example:
This example adds supports in the Fill feature Fill to
specified iBoundary boundary

Fill.AddSupportAtBound iBoundary,iSupport
Parameters:
Return type:

None

property advanced_tolerant_mode: int

Note

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

Returns or sets the tolerant mode taken into account during fill
construction.
Legal values:

0
Unknown tolerant mode.
1
None tolerant mode. Error thrown if maximum deviation exceeds CATIA
resolution.
2
Automatic tolerant mode. Error thrown if maximum deviation exceeds 100
times CATIA resolution.
3
Manual tolerant mode. Error thrown if maximum deviation exceeds input
user deviation.

Example:
This example retrieves in oMode the tolerant mode for the Fill hybrid
shape feature.

Dim oMode
Set oMode = Fill.AdvancedTolerantMode
Return type:

int

append_constraint(i_constraint: Reference) → None

Note

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

Appends an constraint to the hybrid shape fill feature object. ========
ONLY USE IN FSS ==============

Parameters:

iConstraint
The constraint to be appended.

Example:
The following example appends the iConstraint constraint to the Fill
object.

Fill.AppendConstraint iConstraint
Parameters:

i_constraint (Reference) –

Return type:

None

property constraint: Reference

Note

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

Returns or sets the passing point for the Fill.

Example:
This example retrieves in Element the passing point for the Fill hybrid
shape feature.

Dim Element As Reference
Set Element = Fill.Constraint
Return type:

Reference

property continuity: int

Note

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

Returns or sets the continuity between the support and
fill.
Legal values:

0
Continuity in point (C0)
1
Continuity in tangency (C1)
2
Continuity in curvature (C2)

Example:
This example retrieves in oContinuity the continuity type for the Fill
hybrid shape feature.

Dim oContinuity
Set oContinuity = Fill.Continuity
Return type:

int

property detection: int

Note

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

Returns or sets the Canonical portion detection option.
Legal values:

0
No detection of canonical surface
2
Detection of canonical surfaces
Return type:

int

get_bound_at_position(i_pos: int) → Reference

Note

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

Retrieves the boundary at specified position in the hybrid shape fill
feature object.

Parameters:

iPos
The position of the boundary to retrieve.

Example:
The following example gets the oBoundary boundary of the Fill object at
the position iPos.

Dim oBoundary As Reference
Set oBoundary = Fill.GetBoundAtPosition (iPos).
Parameters:

i_pos (int) –

Return type:

Reference

get_bound_position(i_boundary: Reference) → int

Note

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

Retrieves the position of a boundary used by the hybrid shape fill feature
object.

Parameters:

iBoundary
The boundary whose position has to be retrieved.

Example:
The following example gets the oPos position of the iBoundary boundary
in the Fill object.

Dim oPos As long
oPos = Fill.GetBoundPosition (iBoundary).
Parameters:

i_boundary (Reference) –

Return type:

int

get_bound_size() → int

Note

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

Returns the number of boundaries in the Fill object.

Parameters:

oSize
Number of boundaries in the Fill.

Example:
This example retrieves the number of boundaries in the Fill
hybrid shape fill.

Dim oSize As long
oSize = Fill.GetBoundSize
Return type:

int

get_boundary_continuity(i_pos: int) → int

Note

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

Returns the continuity mode for a boundary at specified position in the
Fill.

Parameters:

iPos
Position at which the continuity should be retrieved.

oContinuity
Continuity retrieved between the support and the
fill.
Legal values:

0
Continuity in point (C0)
1
Continuity in tangency (C1)
2
Continuity in curvature (C2)

Example:
This example retrieves in oContinuity the continuity at the specified
position of Fill hybrid shape fill feature.

oContinuity = Fill.GetBoundaryContinuity iPos
Parameters:

i_pos (int) –

Return type:

int

get_constraint_at_position(i_pos: int) → Reference

Note

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

Retrieves the constraint at specified position in the hybrid shape fill
feature object. ======== ONLY USE IN FSS ==============

Parameters:

iPos
The position of the constraint to retrieve.

Example:
The following example gets the oConstraint constraint of the Fill
object at the position iPos.

Dim oConstraint As Reference
Set oConstraint = Fill.GetConstraintAtPosition (iPos).
Parameters:

i_pos (int) –

Return type:

Reference

get_constraints_size() → int

Note

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

Returns the number of constraints in the Fill object.

Parameters:

oSize
Number of constraints in the Fill.

Example:
This example retrieves the number of constraints in the Fill
hybrid shape fill.

Dim oSize As long
oSize = Fill.GetConstraintsSize
Return type:

int

get_support_at_position(i_pos: int) → Reference

Note

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

Retrieves the support at specified position in the hybrid shape fill
feature object.

Parameters:

iPos
The position of the support to retrieve.

Example:
The following example gets the oSupport support of the Fill object at
the position iPos.

Dim oSupport As Reference
Set oSupport = Fill.GetSupportAtPosition (iPos).
Parameters:

i_pos (int) –

Return type:

Reference

insert_bound_after_position(i_boundary: Reference, i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub InsertBoundAfterPosition(Reference iBoundary,
long iPos)

Inserts the boundary after specified position in the Fill.

Parameters:

iBoundary
Reference of the boundary object to be inserted.
iPos
Position after which the element should be
inserted.

Example:
This example inserts the boundary in the Fill feature Fill
after position iPos

Fill.InsertBoundAfterPosition iBoundary,iPos
Parameters:
Return type:

None

property maximum_deviation_value: float

Note

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

Sets or Gets the maximum deviation allowed for smoothing operation in fill
commnd. This value must be set in SI unit (m).

Example: This example retrieves in DeviationValue the maximum deviation
value for the Fill hybrid shape feature.

Dim DeviationValue As double
Set DeviationValue = Fill.MaximumDeviationValue
Return type:

float

property plane_only_mode: bool

Note

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

Returns or sets whether Planar Boundaries only should be considered during
fill operation.
Legal values:

TRUE
Planar boundaries are only considered during Fill
operation
FALSE
Non-Planar boundaries are also considered during Fill
operation
Return type:

bool

remove_all_bound() → None

Note

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

Removes all boundaries of the hybrid shape fill feature object.


Example:
The following example removes all boundaries of the Fill
object.

Fill.RemoveAllBound
Return type:

None

remove_all_constraints() → None

Note

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

Removes all constraints.
Return type:

None

remove_bound_at_position(i_pos: int) → None

Note

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

Removes boundary at specified position in hybrid shape fill feature
object.

Parameters:

iPos
The position of the boundary to remove.

Example:
The following example removes the boundary object from the Fill object
at the position iPos.

Fill.RemoveBoundAtPosition iPos.
Parameters:

i_pos (int) –

Return type:

None

remove_constraint(i_pos: int) → None

Note

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

Removes constraint at specified position in hybrid shape fill feature
object. ======== ONLY USE IN FSS ==============

Parameters:

iPos
The position of the constraint to remove.

Example:
The following example removes the constraint object from the Fill
object at the position iPos.

Fill.RemoveConstraint iPos.
Parameters:

i_pos (int) –

Return type:

None

remove_support_at_position(i_pos: int) → None

Note

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

Removes support at specified position in hybrid shape fill feature
object.

Parameters:

iPos
The position of the support to remove.

Example:
The following example removes the support object from the Fill object
at the position iPos.

Fill.RemoveSupportAtPosition iPos.
Parameters:

i_pos (int) –

Return type:

None

replace_bound_at_position(i_boundary: Reference, i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplaceBoundAtPosition(Reference iBoundary,
long iPos)

Replaces the boundary at specified position in the Fill.

Parameters:

iBoundary
Reference of the boundary object to be replaced.
iPos
Position at which the boundary should be replaced.

Example:
This example replaces the boundary in the Fill feature Fill at
specified position iPos

Fill.ReplaceBoundAtPosition iBoundary,iPos
Parameters:
Return type:

None

replace_constraint(i_pos: int, i_constraint: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplaceConstraint(long iPos,
Reference iConstraint)

Replaces the constraint at specified position in the Fill.

Parameters:

iPos
Position at which the constraint should be replaced.

iConstraint
Reference of the constraint object to be replaced.

Example:
This example replaces the constraint in the Fill feature Fill
at specified position iPos

Fill.ReplaceConstraint iPos,iConstraint
Parameters:

  • i_pos (int) –

  • i_constraint (Reference) –

Return type:

None

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplaceSupportAtPosition(Reference iSupport,
long iPos)

Replaces the support at specified position in the Fill.

Parameters:

iSupport
Reference of the support object to be replaced.
iPos
Position at which the support should be replaced.

Example:
This example replaces the support in the Fill feature Fill at
specified position iPos

Fill.ReplaceSupportAtPosition iSupport,iPos
Parameters:
Return type:

None

set_boundary_continuity(i_continuity: int, i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetBoundaryContinuity(long iContinuity,
long iPos)

Sets the continuity mode for a boundary at specified position in the
Fill.

Parameters:

iContinuity
Continuity between the support and the fill.
Legal values:

0
Continuity in point (C0)
1
Continuity in tangency (C1)
2
Continuity in curvature (C2)

iPos
Position at which the continuity should be set.

Example:
This example sets the continuity in the Fill feature Fill at
specified position iPos

Fill.SetBoundaryContinuity iContinuity,iPos
Parameters:

  • i_continuity (int) –

  • i_pos (int) –

Return type:

None

property tolerant_mode: bool

Note

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

Deprecated:
V5R26 Use HybridShapeFill.AdvancedTolerantMode Returns or sets the Tolerant mode option.
Role: To activate or not the tolerant mode option TRUE : Tolerant mode is active.
Uses deviation parameter to do tolerant fill. FALSE : Tolerant mode is not active.

Example: This example retrieves in tolMode the tolerant mode for the
Fill hybrid shape feature.

Dim tolMode As boolean
Set tolMode = Fill.TolerantMode
Return type:

bool