HybridShapeExtrapol (Object)

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:

Use the CATIAHybridShapeFactory to create a HybridShapeExtrapol object.

See also:

Properties


Property BorderType() As
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)).
Property Boundary() As

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.

Property ConstantLengthMode() As
Returns or sets the constant distance mode in case of Length extrapolation limit.
This applies in case of Length extrapolation limit.
Property ContinuityType() As

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.

Property ElemToExtrapol() As
Returns or sets the curve or surface to extrapolate.
Sub-element(s) supported (see object): see , or .
Property ElemUntil() As

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.

Property ExtendEdgesMode() As
Returns or sets the extension of extrapolated edges mode.
This applies in case of tangent continuity mode, tangent border mode and assembled result.
Property ExtrapolBothSidesIdentically() As
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.
Property Length() As (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.

Property LimitType() As

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.

Property PropagationMode() As
Returns or sets the propagation mode.
This applies in case of curvature extrapolation of a shell.
Property Support() As
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 object): see .

Methods


Func GetBoundary( iPos) As
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 object): see , or .
Func GetContinuityType( iPos) As
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).
Func GetElemUntil( iPos) As
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).
Func GetInternalEdgesElement( iPos) As
Gets an element in the list of internal elements (vertex or edges).
Parameters:
oInternalElement
internal element
iPos
position of internal element to be retrieved.
Func GetLength( iPos) As
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).
Func GetLimitType( iPos) As
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).
Sub GetNumberOfExtrapolations( 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.
Func IsAssemble() As
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
Sub RemoveAllExtrapolationsExceptTheFirstOne()
Removes all extrapolations that may have been set, except the first one.
Sub RemoveAllInternalEdgesElement()
Removes all internal elements.
Sub RemoveExtrapolation( iPos)
Removes the iPos-th extrapolation that has been set.
Sub SetAssemble( 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.
Sub SetBoundary( iPos, iBoundary)
Sub SetContinuityType( iPos, iLim)
Sub SetElemUntil( iPos, iElemUntil)
Sub SetLength( iPos, iLength)
Do not use this method.
Sub SetLengthD( iPos, iLength)
Sub SetLimitType( iPos, iLim)