CATGSMIDLItf HybridShapeTrim (Object)

Represents the hybrid shape trim object.
Role: To access the data of the hybrid shape trim object. This data includes:

The first element (surface or curve) to be trimmed
The second element (surface or curve) to be trimmed
The orientation corresponding to the first element
The orientation corresponding to the second element

Use the CATIAHybridShapeFactory to create a HybridShapeTrim object.

See also:

Property Index
AutomaticExtrapolationMode	Gets or sets the automatic extrapolation mode status.
Connex	Gets or sets connected mode.
FirstElem
FirstOrientation
IntersectionComputation	Gets or sets Intersection computation mode.
KeepAllPieces	Gets or Sets keep all pieces mode.
Manifold	Gets or sets manifold mode.
Mode	Gets or sets Trim mode.
SecondElem
SecondOrientation
Simplify	Returns or sets whether the simplification of the resulting topology is or should be activated.
Support	Returns or sets the support element.

Method Index
AddElementToKeep	Adds an element to specifications.
AddElementToRemove	Adds an element to specifications.
AddPieceCutter	Add piece Cutting element and its orientation.
GetElem	Gets the trimmed feature at a given index.
GetKeptElem	Gets the kept feature at a given index.
GetNbElem	Gets the number of elements: couple(element, index of portion to keep on element).
GetNbElementsToKeep	Gets the number of elements to keep.
GetNbElementsToRemove	Gets the number of elements to remove.
GetNextOrientation	Gets Orientation used to compute the feature, referring to the next trimmed element.
GetPieceCutter	Gets piece Cutting element and its orientation.
GetPieceDiscriminationIndex	Gets the discrimination index.
GetPieceNbCutters	Gets the number of cutters of a piece.
GetPortionToKeep	Gets a portion to keep number, giving the index of the element.
GetPreviousOrientation	Gets Orientation used to compute the feature, referring to the previous trimmed element.
GetRemovedElem	Gets the removed feature at a given index.
InvertFirstOrientation
InvertSecondOrientation
RemoveElementToKeep	Removes an element from specifications.
RemoveElementToRemove	Removes an element from specifications.
RemovePieceCutter	Remove piece Cutting element and its orientation.
SetElem	Modifies the trimmed feature at a given index.
SetNextOrientation	Sets the orientation used to compute the feature, referring to the next trimmed element.
SetPieceDiscriminationIndex	Sets the discrimination index.
SetPortionToKeep	Sets a portion to keep number in Pieces mode.
SetPreviousOrientation	Sets the orientation used to compute the feature, referring to the previous trimmed element.

Properties

Property AutomaticExtrapolationMode() As

Gets or sets the automatic extrapolation mode status. AutomaticExtrapolationMode = TRUE : Automatic extrapolation mode is on. = FALSE : Automatic extrapolation mode is off. This example retrieves in AutoExtrapolMode the automatic extrapolation mode status for the Trim hybrid shape feature.

 Dim AutoExtrapolMode As boolean
 AutoExtrapolMode = Trim.AutomaticExtrapolationMode

Property Connex() As

Gets or sets connected mode. Connex = TRUE : the check of connexity is enable. Connex = FALSE : the check of connexity is disable. This example retrieves in Connex the connected mode for the Trim hybrid shape feature.

 Dim Connex As boolean
 Connex = Trim.Connex

Property FirstElem() As

Deprecated:

V5R17 CATIAHybridShapeTrim#GetElem Returns or sets the first element to be trimmed.

Example:

 This example retrieves in Surface1 the first element to be trimmed 
 for the hybTrim hybrid shape feature.
  Dim Surface1 As Reference
 Set Surface1 = hybTrim.FirstElem

Property FirstOrientation() As

Deprecated:

V5R17 CATIAHybridShapeTrim#GetPreviousOrientation Returns or sets the first orientation used to compute the trim.
Role: The orientation specifies the kept parts of the first element to be trimmed.

When trimming surfaces:
- If orientation value is 1: kept parts are specified by the "natural" normal to the second object
- If orientation value is -1: kept parts are specified by the inverse of the "natural" normal to the second object
When trimming curves:
- If orientation value is 1: kept parts are from the beginning of the curve to the first intersection, and, if there is one, from the second to the third intersection and so on until the end of the curve
- If orientation value is -1: kept parts are from the first intersection to the second (if there is one), and, if there is one, from the third to the fourth and so on until the end of the curve.

Example:

 This example retrieves in firstOrient the orientation of
 the first element used by the hybTrim hybrid shape feature.
 Dim firstOrient As long
 Set firstOrient = hybTrim.FirstOrientation

Property IntersectionComputation() As

Gets or sets Intersection computation mode. IntersectionComputation = TRUE : Intersection is computed. = FALSE : Intersection is not computed. This example retrieves in Intersection the Intersection computation mode for the Trim hybrid shape feature.

 Dim Intersection As boolean
 Intersection = Trim.IntersectionComputation

Property KeepAllPieces() As

Gets or Sets keep all pieces mode. Used for the trim pieces of shells only KeepAllPieces=TRUE : all the pieces are kept during update, KeepAllPieces=FALSE : only chosen pieces are kept during update (default). This example retrieves in KeepAllPieces the Keep All Pieces mode for the Trim hybrid shape feature.

 Dim bKeepAllPieces As boolean
 bKeepAllPieces = Trim.KeepAllPieces

Property Manifold() As

Gets or sets manifold mode. Manifold = TRUE : the check of manifold is enable. Manifold = FALSE : the check of manifold is disable. This example retrieves in Manifold the manifold mode for the Trim hybrid shape feature.

 Dim Manifold As boolean
 Connex = Trim.Manifold

Property Mode() As

Gets or sets Trim mode. Mode = 1 : Standard. = 2 : Pieces. This example retrieves in Mode the mode for the Trim hybrid shape feature.

 Dim Mode As long
 Mode = Trim.Mode

Property SecondElem() As

Deprecated:

V5R17 CATIAHybridShapeTrim#GetElem Returns or sets the second element to be trimmed.

Example:

 This example retrieves in Surface2 the second element to be trimmed 
 for the hybTrim hybrid shape trim object.
  Dim Surface2 As Reference
 Set Surface2 = hybTrim.SecondElem

Property SecondOrientation() As

Deprecated:

V5R17 CATIAHybridShapeTrim#GetPreviousOrientation Returns or sets the second orientation used to compute the trim.
Role: The orientation specifies the kept parts of the second element to be trimmed.

When trimming surfaces:
- If orientation value is 1: kept parts are specified by the "natural" normal to the first object
- If orientation value is -1: kept parts are specified by the inverse of the "natural" normal to the first object
When trimming curves:
- If orientation value is 1: kept parts are from the beginning of the curve to the first intersection, and, if there is one, from the second to the third intersection and so on until the end of the curve
- If orientation value is -1: kept parts are from the first intersection to the second (if there is one), and, if there is one, from the third to the fourth and so on until the end of the curve.

Example:

 This example retrieves in secondOrient the orientation of
 the second element used by the hybTrim hybrid shape trim object.
 Dim secondOrient As long
 Set secondOrient = hybTrim.SecondOrientation

Property Simplify() As

Returns or sets whether the simplification of the resulting topology is or should be activated.
Legal values: True to activate the simplification, and False otherwise.

Example:

  This example activates the simplification of the resulting topology of
 the hybTrim hybrid shape trim object.
   hybTrim.Simplify = True

Property Support() As

Returns or sets the support element.
This support element may not exist.
Sub-element(s) supported (see object): .

Example:

 This example retrieves in supportElement the support element
 of the hybTrim hybrid shape trim object.
  Dim supportElement As Reference
 Set supportElement = hybTrim.Support

Methods

Sub AddElementToKeep( iElement)

Adds an element to specifications. This element will be kept.

Parameters:

iElement: Element to keep.

Sub AddElementToRemove( iElement)

Adds an element to specifications. This element will be removed.

Parameters:

iElement: Element to remove.

Sub AddPieceCutter( iRank, iCutterElem, iOrientation)

Add piece Cutting element and its orientation. Used for trim pieces of shells only

Parameters:

iRank: Index of the trimmed element (piece)
iCutterElemIdx: index is the index of input shell except in case of multiple intersection between shells where Index=IndexInputShell+NbInputShells*(1-iw) (whith iw=1... : wire index in case of multiple intersection)
iOrientation: cutter element orientation

Func GetElem( iRank) As

Gets the trimmed feature at a given index.

Parameters:

iRank: Index of one of the trimmed features
oElem: trimmed feature

Func GetKeptElem( iRank) As

Gets the kept feature at a given index.

Parameters:

oElem: Kept feature
iRank: Index of one of the kept features

Func GetNbElem() As

Gets the number of elements: couple(element, index of portion to keep on element).

Parameters:

oNbElem: Number of elements

Func GetNbElementsToKeep() As

Gets the number of elements to keep.

Parameters:

oNbElementsToKeep: Number of elements to keep

Func GetNbElementsToRemove() As

Gets the number of elements to remove.

Parameters:

oNbElementsToRemove: Number of elements to remove

Func GetNextOrientation( iRank) As

Gets Orientation used to compute the feature, referring to the next trimmed element.

Parameters:

iRank: index (of one of the trimmed features) - 1 iRank must be greater than 1 and lower than the number of elements - 1
oOrientation: Orientation

Sub GetPieceCutter( iRank, iCutterIndex, oCutterElemIdx, oOrientation)

Gets piece Cutting element and its orientation. Used for trim pieces of shells only

Parameters:

iRank: Index of the trimmed element (piece)
oCutterElemIdx: index is the index of input shell except in case of multiple intersection between shells where Index=IndexInputShell+NbInputShells*(1-iw) (whith iw=1... : wire index in case of multiple intersection)
oCutterElem: cutter element
oOrientation: cutter element orientation

Sub GetPieceDiscriminationIndex( iRank, oIndex)

Gets the discrimination index. Used for the trim pieces of shells only

Parameters:

iRank: Index of the trimmed element (piece)
oIndex: Discrimination Index Used to discrimine pieces when cutters orientations are not enough

Func GetPieceNbCutters( iRank) As

Gets the number of cutters of a piece. Used for trim pieces of shells only

Parameters:

oNbCutters: Number of cutters (except in case of multiple intersection between shells)

Func GetPortionToKeep( iRank) As

Gets a portion to keep number, giving the index of the element. Used for trim pieces of wires

Parameters:

oPortionNumber: Index of portion to keep on the element
iRank: Index of the trimmed element

Func GetPreviousOrientation( iRank) As

Gets Orientation used to compute the feature, referring to the previous trimmed element.

Parameters:

iRank: index (of one of the trimmed features) - 1 iRank must be greater than 1 and lower than the number of elements - 1
oOrientation: Orientation

Func GetRemovedElem( iRank) As

Gets the removed feature at a given index.

Parameters:

oElem: Removed feature
iRank: Index of one of the removed features

Sub InvertFirstOrientation()

Deprecated:

V5R17 CATIAHybridShapeTrim#SetPreviousOrientation Inverts the first orientation used to compute the trim.

Example:

 This example inverts the first orientation to compute
 the hybTrim hybrid shape trim object.
 hybTrim.InvertFirstOrientation

Sub InvertSecondOrientation()

Deprecated:

V5R17 CATIAHybridShapeTrim#SetPreviousOrientation Inverts the second orientation used to compute the trim. This example inverts the first orientation to compute the hybTrim hybrid shape trim object.

 hybTrim.InvertSecondOrientation

Sub RemoveElementToKeep( iRank)

Removes an element from specifications.

Parameters:

iRank: Index of the kept element.

Sub RemoveElementToRemove( iRank)

Removes an element from specifications.

Parameters:

iRank: Index of the removed element.

Sub RemovePieceCutter( iRank, iCutterIndex)

Remove piece Cutting element and its orientation. Used for trim pieces of shells only

Parameters:

iRank: Index of the trimmed element (piece)
iCutterIndex: Index in cutters list

Sub SetElem( iRank, iElem)

Modifies the trimmed feature at a given index. Use AddElem method to specify a new trimmed element

Parameters:

iRank: Index of one of the trimmed features
iElem: trimmed feature

Sub SetNextOrientation( iRank, iOrientation)

Sets the orientation used to compute the feature, referring to the next trimmed element.

Parameters:

iRank: index (of one of the trimmed features) - 1 iRank must be greater than 1 and lower than the number of elements - 1
iOrientation: Orientation

Sub SetPieceDiscriminationIndex( iRank, iIndex)

Sets the discrimination index. Used for the trim pieces of shells only

Parameters:

iRank: Index of the trimmed element (piece)
iIndex: Discrimination Index Used to discrimine pieces when cutters orientations are not enough

Sub SetPortionToKeep( iRank, iPortionNumber)

Sets a portion to keep number in Pieces mode. Used for trim pieces of wires

Parameters:

iRank: Index of the trimmed element
iPortionNumber: Index of portion to keep on the element

Sub SetPreviousOrientation( iRank, iOrientation)

Sets the orientation used to compute the feature, referring to the previous trimmed element.

Parameters:

iRank: index (of one of the trimmed features) - 1 iRank must be greater than 1 and lower than the number of elements - 1
iOrientation: Orientation