All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseTrim

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIGSMUseTrim

Interface to trim feature.
Role: Allows you to access data of the Trim feature created by using two elements (two curves or two surfaces) and two orientations

See also:

Method Index

o AddElem(CATIMmiMechanicalFeature_var&): Appends an element to trim.
o AddElementToKeep(CATIMmiMechanicalFeature_var): Adds an element to specifications.
o AddElementToRemove(CATIMmiMechanicalFeature_var): Adds an element to specifications.
o GetAutomaticExtrapolationMode(CATBoolean&): Queries whether automatic extrapolation mode is activated or not.
o GetConnexMode(CATBoolean&): Gets the connected mode.
o GetElem(CATIMmiMechanicalFeature_var&,int): Gets the trimmed feature at a given index.
o GetElems(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets the list of trimmed features, removing duplicated.
o GetFirstElem(CATIMmiMechanicalFeature_var&)
o GetFirstOrientation(CATGSMOrientation&)
o GetIntersection(CATIMmiMechanicalFeature_var&): Gets the intersection.
o GetIntersectionComputation(CATBoolean&): Queries whether intersection is computed or not.
o GetKeepAllPiecesMode(CATBoolean&): Gets keep all pieces mode.
o GetKeptElem(CATIMmiMechanicalFeature_var&,int): Gets the kept feature at a given index.
o GetManifoldMode(CATBoolean&): Gets the Manifold mode.
o GetMode(int&): Gets Trim mode.
o GetNbElem(int&): Gets the number of elements: couple(element, index of portion to keep on element).
o GetNbElementsToKeep(int&): Gets the number of elements to keep.
o GetNbElementsToRemove(int&): Gets the number of elements to remove.
o GetNextOrientation(CATGSMOrientation&,int): Gets Orientation used to compute the feature, referring to the next trimmed element.
o GetNumberOfIntersections(CATIMmiMechanicalFeature_var,int&): Gets the number of intersections with the other elements, the index of the element, in Pieces mode.
o GetPieceCutters(int,CATListOfInt&,CATListOfInt&): Gets the pieces cutters.
o GetPieceDiscriminationIndex(int,int&): Gets the discrimination index.
o GetPortionToKeep(int&,int): Gets a portion to keep number, giving the index of the element.
o GetPreviousOrientation(CATGSMOrientation&,int): Gets Orientation used to compute the feature, referring to the previous trimmed element.
o GetRemovedElem(CATIMmiMechanicalFeature_var&,int): Gets the removed feature at a given index.
o GetSecondElem(CATIMmiMechanicalFeature_var&)
o GetSecondOrientation(CATGSMOrientation&)
o GetSimplify(CATBoolean&): Queries whether resulting topology is simplified or not.
o GetSupportElem(CATIMmiMechanicalFeature_var&): Gets the support of the curves to trim (optional).
o InsertElem(CATIMmiMechanicalFeature_var,int): Inserts an element.
o InvertFirstOrientation()
o InvertNextOrientation(int): Inverts the orientation used to compute the trim refering the next trimmed element.
o InvertPreviousOrientation(int): Inverts the orientation used to compute the trim refering the previous trimmed element.
o InvertSecondOrientation()
o MigrateFromBinary(): Migrate binary feature to Standard mode.
o RemoveElem(int): Removes a feature at a given index.
o RemoveElementToKeep(int): Removes an element from specifications.
o RemoveElementToRemove(int): Removes an element from specifications.
o SetAutomaticExtrapolationMode(CATBoolean): Sets or unsets the automatic extrapolation mode.
o SetConnexMode(CATBoolean): Sets the connected mode.
o SetElem(CATIMmiMechanicalFeature_var,int): Modifies the trimmed feature at a given index.
o SetFirstElem(CATIMmiMechanicalFeature_var)
o SetFirstOrientation(CATGSMOrientation)
o SetIntersectionComputation(CATBoolean): Sets or unsets the computation of intersection.
o SetKeepAllPiecesMode(CATBoolean): Sets keep all pieces mode.
o SetManifoldMode(CATBoolean): Sets the Manifold mode.
o SetMode(int): Sets Trim mode.
o SetNextOrientation(CATGSMOrientation,int): Sets the orientation used to compute the feature, referring to the next trimmed element.
o SetNumberOfIntersections(CATIMmiMechanicalFeature_var,int): Sets the number of intersections with the other elements, in Pieces mode.
o SetPieceCutters(int,CATListOfInt&,CATListOfInt&): Sets the pieces cutters.
o SetPieceDiscriminationIndex(int,int): Sets the discrimination index.
o SetPortionToKeep(int,int): Sets a portion to keep number in Pieces mode.
o SetPreviousOrientation(CATGSMOrientation,int): Sets the orientation used to compute the feature, referring to the previous trimmed element.
o SetSecondElem(CATIMmiMechanicalFeature_var)
o SetSecondOrientation(CATGSMOrientation)
o SetSimplify(CATBoolean): Sets or unsets the simplification of the resulting topology.
o SetSupportElem(CATIMmiMechanicalFeature_var): Sets the support of the curves to trim (optional).

Methods

o AddElem

public virtual AddElem( const iElem)

Appends an element to trim.

Parameters:

iElem: feature to trim

o AddElementToKeep

public virtual AddElementToKeep( const iElement)

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

Parameters:

iElement: Element to keep.

o AddElementToRemove

public virtual AddElementToRemove( const iElement)

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

Parameters:

iElement: Element to remove.

o GetAutomaticExtrapolationMode

public virtual GetAutomaticExtrapolationMode( oMode)

Queries whether automatic extrapolation mode is activated or not.

Parameters:

oMode: Extrapolation mode on (TRUE) or off (FALSE)

o GetConnexMode

public virtual GetConnexMode( oConnex)

Gets the connected mode.

Parameters:

oConnex: CATFalse = non connected elements, CATTrue = only connected elements

See also:

o GetElem

public virtual GetElem(		`oElem`,
	const	`iRank`)

Gets the trimmed feature at a given index.

Parameters:

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

o GetElems

public virtual GetElems( oElems)

Gets the list of trimmed features, removing duplicated.

Parameters:

oElems: The list of trimmed features

o GetFirstElem

public virtual GetFirstElem( oElem)

Deprecated:

V5R17 CATIGSMUseTrim#GetElem Gets the first feature to trim (a curve or surface).

Parameters:

oElem: first feature to trim

o GetFirstOrientation

public virtual GetFirstOrientation( oOrientation)

Deprecated:

V5R17 CATIGSMUseTrim#GetNextOrientation Gets the first orientation used to compute the trim. Orientation specifies kept parts of first feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the second feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the second feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from 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 CATGSMInvertOrientation: 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...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the first curve are specified by the result of the cross product : normal(support surface)^tangent(second curve)
- If CATGSMInvertOrientation:
Kept parts of the first curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(second curve)

Parameters:

oOrientation: first orientation used to compute the trim

o GetIntersection

public virtual GetIntersection( oElem)

Gets the intersection.

Parameters:

oElem: Intersection

o GetIntersectionComputation

public virtual GetIntersectionComputation( oMode)

Queries whether intersection is computed or not.

Parameters:

oMode: Computation option on (TRUE) or off (FALSE)

o GetKeepAllPiecesMode

public virtual GetKeepAllPiecesMode( oKeepAllPieces)

Gets keep all pieces mode. Used for the trim pieces of shells only

Parameters:

oKeepAllPieces: CATTrue : all the pieces are kept during update, CATFalse : only chosen pieces are kept during update (default).

See also:

o GetKeptElem

public virtual GetKeptElem(		`oElem`,
	const	`iRank`)

Gets the kept feature at a given index.

Parameters:

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

o GetManifoldMode

public virtual GetManifoldMode( oIsManifold)

Gets the Manifold mode.

Parameters:

oIsManifold: CATFalse = the check is not performed (non manifold result is allowed), CATTrue = the check is performed.

See also:

o GetMode

public virtual GetMode( oMode)

Gets Trim mode.

Parameters:

oMode: =1 Standard =2 Pieces

o GetNbElem

public virtual GetNbElem( oNbElem)

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

Parameters:

oNbElem: Number of elements

o GetNbElementsToKeep

public virtual GetNbElementsToKeep( oNbElementsToKeep)

Gets the number of elements to keep.

Parameters:

oNbElementsToKeep: Number of elements to keep

o GetNbElementsToRemove

public virtual GetNbElementsToRemove( oNbElementsToRemove)

Gets the number of elements to remove.

Parameters:

oNbElementsToRemove: Number of elements to remove

o GetNextOrientation

public virtual GetNextOrientation(		`oOrientation`,
	const	`iRank`	`=1`)

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

Parameters:

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

o GetNumberOfIntersections

public virtual GetNumberOfIntersections(	const	`iElem`,
		`oNbIntersections`)

Gets the number of intersections with the other elements, the index of the element, in Pieces mode. Used for the trim pieces of wires only If iNumberOfIntersections<0, No check of the number of intersections at Update

Parameters:

iElem: trimmed feature
oNbIntersections: Number of intersections

o GetPieceCutters

public virtual GetPieceCutters(	const	`iRank`,
		`oListCuttersIndex`,
		`oListOrientations`)

Gets the pieces cutters. Used for the trim pieces of shells only

Parameters:

iRank
oListCuttersIndex(1-iw)
oListOrientations

o GetPieceDiscriminationIndex

public virtual GetPieceDiscriminationIndex(	const	`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

o GetPortionToKeep

public virtual GetPortionToKeep(		`oPortionNumber`,
	const	`iRank`)

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

Parameters:

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

o GetPreviousOrientation

public virtual GetPreviousOrientation(		`oOrientation`,
	const	`iRank`	`=1`)

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

Parameters:

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

o GetRemovedElem

public virtual GetRemovedElem(		`oElem`,
	const	`iRank`)

Gets the removed feature at a given index.

Parameters:

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

o GetSecondElem

public virtual GetSecondElem( oElem)

Deprecated:

V5R17 CATIGSMUseTrim#GetElem Gets the second feature to trim (a curve or surface).

Parameters:

oElem: second feature to cut

o GetSecondOrientation

public virtual GetSecondOrientation( oOrientation)

Deprecated:

V5R17 CATIGSMUseTrim#GetPreviousOrientation Gets the second orientation used to compute the trim. Orientation specifies kept parts of second feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the first feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the first feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from 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 CATGSMInvertOrientation: 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...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the second curve are specified by the result of the cross product : normal(support surface)^tangent(first curve)
- If CATGSMInvertOrientation:
Kept parts of the second curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(first curve)

Parameters:

oOrientation: second orientation used to compute the trim

o GetSimplify

public virtual GetSimplify( oMode)

Queries whether resulting topology is simplified or not.

Parameters:

oMode: Simplification option on (TRUE) or off (FALSE)

o GetSupportElem

public virtual GetSupportElem( oElem)

Gets the support of the curves to trim (optional).

Parameters:

oElem: Support surface

o InsertElem

public virtual InsertElem(	const	`iElem`,
	const	`iPosition`)

Inserts an element.

Parameters:

iPosition: The position of the element in the list of elements.
iElem: the element.

o InvertFirstOrientation

public virtual InvertFirstOrientation(

)

Deprecated:: V5R17 CATIGSMUseTrim#InvertNextOrientation Inverts the first orientation used to compute the trim.

o InvertNextOrientation

public virtual InvertNextOrientation( const iRank =1)

Inverts the orientation used to compute the trim refering the next trimmed element.

o InvertPreviousOrientation

public virtual InvertPreviousOrientation( const iRank =1)

Inverts the orientation used to compute the trim refering the previous trimmed element.

o InvertSecondOrientation

public virtual InvertSecondOrientation(

)

Deprecated:: V5R17 CATIGSMUseTrim#InvertPreviousOrientation Inverts the second orientation used to compute the trim.

o MigrateFromBinary

public virtual MigrateFromBinary(

)

Migrate binary feature to Standard mode.

o RemoveElem

public virtual RemoveElem( const iRank)

Removes a feature at a given index.

Parameters:

iRank: index of the feature

o RemoveElementToKeep

public virtual RemoveElementToKeep( const iRank)

Removes an element from specifications.

Parameters:

iRank: Index of the kept element.

o RemoveElementToRemove

public virtual RemoveElementToRemove( const iRank)

Removes an element from specifications.

Parameters:

iRank: Index of the removed element.

o SetAutomaticExtrapolationMode

public virtual SetAutomaticExtrapolationMode( iMode)

Sets or unsets the automatic extrapolation mode.

Parameters:

iMode: Extrapolation mode on (TRUE) or off (FALSE)

o SetConnexMode

public virtual SetConnexMode( iConnex)

Sets the connected mode.

Parameters:

iConnex: CATTrue = the check of connexity is enable, CATFalse = the check of connexity is disable.

See also:

o SetElem

public virtual SetElem(	const	`iElem`,
	const	`iRank`)

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

Parameters:

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

o SetFirstElem

public virtual SetFirstElem( const iElem)

Deprecated:

V5R17 CATIGSMUseTrim#SetElem Sets the first feature to trim (a curve or surface).

Parameters:

iElem: first feature to trim

o SetFirstOrientation

public virtual SetFirstOrientation( iOrientation)

Deprecated:

V5R17 CATIGSMUseTrim#SetNextOrientation(1) Sets the first orientation used to compute the trim. Orientation specifies kept parts of first feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the second feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the second feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from 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 CATGSMInvertOrientation: 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...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the first curve are specified by the result of the cross product : normal(support surface)^tangent(second curve)
- If CATGSMInvertOrientation:
Kept parts of the first curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(second curve)

Parameters:

iOrientation: first orientation used to compute the trim

o SetIntersectionComputation

public virtual SetIntersectionComputation( iMode)

Sets or unsets the computation of intersection.

Parameters:

iMode: Computation option on (TRUE) or off (FALSE)

o SetKeepAllPiecesMode

public virtual SetKeepAllPiecesMode( iKeepAllPieces)

Sets keep all pieces mode. Used for the trim pieces of shells only

Parameters:

iKeepAllPieces: CATTrue : all the pieces are kept during update, CATFalse : only chosen pieces are kept during update (default).

See also:

o SetManifoldMode

public virtual SetManifoldMode( iIsManifold)

Sets the Manifold mode.

Parameters:

iIsManifold: CATFalse = the check is not performed (non manifold result is allowed), CATTrue = the check is performed.

See also:

o SetMode

public virtual SetMode( const iMode)

Sets Trim mode.

Parameters:

iMode: =1 Standard =2 Pieces

o SetNextOrientation

public virtual SetNextOrientation(		`iOrientation`,
		`iRank`)

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

Parameters:

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

o SetNumberOfIntersections

public virtual SetNumberOfIntersections(	const	`iElem`,
	const	`iNbIntersections`)

Sets the number of intersections with the other elements, in Pieces mode. Used for the trim pieces of wires only If iNumberOfIntersections<0, No check of the number of intersections at Update

Parameters:

iElem: trimmed feature
iNumberOfIntersections: Number of intersections

o SetPieceCutters

public virtual SetPieceCutters(	const	`iRank`,
	const	`iListCuttersIndex`,
	const	`iListOrientations`)

Sets the pieces cutters. Used for the trim pieces of shells only

Parameters:

iRank
iListCuttersIndex(1-iw)
iListOrientations

o SetPieceDiscriminationIndex

public virtual SetPieceDiscriminationIndex(	const	`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

o SetPortionToKeep

public virtual SetPortionToKeep(	const	`iPortionNumber`,
	const	`iRank`)

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

Parameters:

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

o SetPreviousOrientation

public virtual SetPreviousOrientation(		`iOrientation`,
		`iRank`)

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

Parameters:

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

o SetSecondElem

public virtual SetSecondElem( const iElem)

Deprecated:

V5R17 CATIGSMUseTrim#SetElem Sets the second feature to trim (a curve or surface).

Parameters:

iElem: second feature to cut

o SetSecondOrientation

public virtual SetSecondOrientation( iOrientation)

Deprecated:

V5R17 CATIGSMUseTrim#SetPreviousOrientation(1) Sets the second orientation used to compute the trim. Orientation specifies kept parts of second feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the first feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the first feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from 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 CATGSMInvertOrientation: 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...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the second curve are specified by the result of the cross product : normal(support surface)^tangent(first curve)
- If CATGSMInvertOrientation:
Kept parts of the second curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(first curve)

Parameters:

iOrientation: second orientation used to compute the trim

o SetSimplify

public virtual SetSimplify( iMode)

Sets or unsets the simplification of the resulting topology.

Parameters:

iMode: Simplification option on (TRUE) or off (FALSE)

o SetSupportElem

public virtual SetSupportElem( const iElem)

Sets the support of the curves to trim (optional).

Parameters:

iElem: Support surface

This object is included in the file: CATIGSMUseTrim.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf