pycatia.hybrid_shape_interfaces.hybrid_shape_extrapol

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_extrapol.HybridShapeExtrapol(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
HybridShapeExtrapol

Represents the hybrid shape extrapolation feature object.
Role: To access the data of the hybrid shape affinity feature object. The
hybrid shape extrapolation feature object is created by using an element (a
curve or a surface), a boundary of this element (a point in case of curve
extrapolation or a curve in case of surface extrapolation), and a limit (which
can be specified by a length or a limit element).
The continuity between the extrapolated element and the extrapolation can be
either tangent continuity or curvature continuity.
The extrapolation can be assembled or not with the extrapolated curve or
surface. In case of surface extrapolation, extrapolation borders can
be:

Normal to the boundary of the extrapolated surface
Tangent to the edges of the extrapolated surface, that are adjacent to the
boundary

Use the CATIAHybridShapeFactory to create a HybridShapeExtrapol
object.

See also:
HybridShapeFactory
property border_type: int

Note

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

Returns or sets the border type of extrapolation.
This applies for surface extrapolation only.
Legal values: the border type is either normal to the boundary of the
extrapolated surface (CATGSMNormalBorder(=0)), or tangent to the edges of the
extrapolated surface that are adjacent to the boundary
CATGSMTangentBorder(=1)).
Return type:

int

property boundary: Reference

Note

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

This method is left available for compatibility reasons but it is
preferable to use the GetBoundary method instead.

Migration instructions: use the signature that uses an integer as the first
argument.
Return type:

Reference

property constant_length_mode: bool

Note

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

Returns or sets the constant distance mode in case of Length extrapolation
limit.
This applies in case of Length extrapolation limit.
Return type:

bool

property continuity_type: int

Note

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

This method is left available for compatibility reasons but it is
preferable to use the GetContinuityType method instead.

Migration instructions: use the signature that uses an integer as the first
argument.
Return type:

int

property elem_to_extrapol: Reference

Note

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

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

Reference

property elem_until: Reference

Note

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

This method is left available for compatibility reasons but it is
preferable to use the GetElemUntil method instead.

Migration instructions: use the signature that uses an integer as the first
argument.
Return type:

Reference

property extend_edges_mode: bool

Note

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

Returns or sets the extension of extrapolated edges mode.
This applies in case of tangent continuity mode, tangent border mode and
assembled result.
Return type:

bool

property extrapol_both_sides_identically: bool

Note

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

Returns or sets the the boolean telling if the second side is extrapolated
according to the first side’s settings or to its own ones.
This applies in case the element to extrapol is a wire.
Return type:

bool

get_boundary(i_pos: int) → Reference

Note

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

Returns or sets the iPos-th boundary of an extrapolated curve or surface
from which extrapolation begins. If iPos equals 0 or the number of
extrapolations, SetBoundary appends iBoundary to the list of
boundaries.
The boudary is a point for an extrapolated curve, or a curve for an
extrapolated surface.
Sub-element(s) supported (see Boundary object): see Face , TriDimFeatEdge
or BiDimFeatEdge.
Parameters:

i_pos (int) –

Return type:

Reference

get_continuity_type(i_pos: int) → int

Note

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

Returns or sets the continuity type between extrapolated element and
extrapolation at the iPos-th boundary. If iPos equals 0 or the number of
extrapolations, SetContinuityType appends iLim to the list of
lengths.
Legal values: the continuity type is either CATGSMTangentContinuity (=0) or
CATGSMCurvatureContinuity (=1).
Parameters:

i_pos (int) –

Return type:

int

get_elem_until(i_pos: int) → Reference

Note

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

Returns or sets the surface or volume specifying the limit of the
extrapolation that begins from the iPos-th boundary. If iPos equals 0 or the
number of extrapolations, SetElemUntil appends iElemUntil to the list of up-to
elements.
This applies when the limit type is CATGSMUpToElementLimit (=1).
Parameters:

i_pos (int) –

Return type:

Reference

get_internal_edges_element(i_pos: int) → Reference

Note

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

Gets an element in the list of internal elements (vertex or
edges).

Parameters:

oInternalElement
internal element
iPos
position of internal element to be retrieved.
Parameters:

i_pos (int) –

Return type:

Reference

get_length(i_pos: int) → Length

Note

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

Returns or sets the length specifying the limit of the extrapolation that
begins from the iPos-th boundary. If iPos equals 0 or the number of
extrapolations, SetLength appends iLength to the list of
lengths.
This applies when the limit type is CATGSMLengthLimit (=0).
Parameters:

i_pos (int) –

Return type:

Length

get_limit_type(i_pos: int) → int

Note

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

Returns or sets the limit type of the extrapolation that begins from the
iPos-th boundary. If iPos equals 0 or the number of extrapolations,
SetLimitType appends iLim to the list of limit types.
The limit can be a length, a surface, or a volume.
Legal values: the limit type is either CATGSMLengthLimit(0) or
CATGSMUpToElementLimit(1).
Parameters:

i_pos (int) –

Return type:

int

get_number_of_extrapolations() → int

Note

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

Returns the number of extrapolations set. An extrapolation is specified by
a boundary of the element to extrapolate, a limit type, a limit and a
continuity type.
Return type:

int

is_assemble() → bool

Note

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

Retrieves whether extrapolation is assembled with extrapolated curve or
surface.

Parameters:

oAssemble
The assemble option
True when the extrapolation is assembled with extrapolated curve or
surface, and False otherwise
Return type:

bool

property length: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Length() As Length (Read Only)

This method is left available for compatibility reasons but it is
preferable to use the GetLength method instead.

Migration instructions: use the signature that uses an integer as the first
argument.
Return type:

Length

property limit_type: int

Note

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

This method is left available for compatibility reasons but it is
preferable to use the GetLimitType method instead.

Migration instructions: use the signature that uses an integer as the first
argument.
Return type:

int

property propagation_mode: int

Note

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

Returns or sets the propagation mode.
This applies in case of curvature extrapolation of a shell.
Return type:

int

remove_all_extrapolations_except_the_first_one() → None

Note

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

Removes all extrapolations that may have been set, except the first one.
Return type:

None

remove_all_internal_edges_element() → None

Note

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

Removes all internal elements.
Return type:

None

remove_extrapolation(i_pos: int) → None

Note

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

Removes the iPos-th extrapolation that has been set.
Parameters:

i_pos (int) –

Return type:

None

set_assemble(i_assemble: bool) → None

Note

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

Sets whether extrapolation is to be assembled with extrapolated curve or
surface.

Parameters:

iAssemble
The assemble option
True when the extrapolation is to be assembled with extrapolated
curve or surface, and False otherwise.
Parameters:

i_assemble (bool) –

Return type:

None

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

Note

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

None

set_continuity_type(i_pos: int, i_lim: int) → None

Note

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

  • i_pos (int) –

  • i_lim (int) –

Return type:

None

set_elem_until(i_pos: int, i_elem_until: Reference) → None

Note

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

  • i_pos (int) –

  • i_elem_until (Reference) –

Return type:

None

set_length(i_pos: int, i_length: Length) → None

Note

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

Do not use this method.
Parameters:

  • i_pos (int) –

  • i_length (Length) –

Return type:

None

set_length_d(i_pos: int, i_length: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetLengthD(long iPos,
double iLength)
Parameters:

  • i_pos (int) –

  • i_length (float) –

Return type:

None

set_limit_type(i_pos: int, i_lim: int) → None

Note

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

  • i_pos (int) –

  • i_lim (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 surface.
This applies in case of tangent extrapolation of a wire. If a support
surface is given, the extrapolation will lie on it.
Sub-element(s) supported (see Boundary object): see Face.
Return type:

Reference