All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseSplit

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

interface CATIGSMUseSplit

Interface to split feature.
Role: Allows you to access data of the Split feature created by using an element to cut (a curve or a surface), one or several cutting elements (points, curves or surfaces) and an orientation for each cutting element.

LICENSING INFORMATION: Creation of volume result requires GSO License
if GSO License is not granted , settting of Volume result has not effect

See also:

Method Index

o AddCuttingElem(CATIMmiMechanicalFeature_var&,CATGSMOrientation): Adds a cutting feature.
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 GetBothSidesMode(CATBoolean&): Queries whether both sides are computed or not.
o GetCuttingElem(CATIMmiMechanicalFeature_var&): Gets the cutting feature (a point, a curve or a surface).
o GetCuttingElem(CATIMmiMechanicalFeature_var&,int): Gets the cutting feature at a given index (a point, a curve or a surface).
o GetElemToCut(CATIMmiMechanicalFeature_var&): Gets the feature to cut (a curve or a surface).
o GetIgnoreNoIntersectingMode(CATBoolean&): Queries whether 'Ignore no intersecting elements' mode is activated or not.
o GetIntersection(CATIMmiMechanicalFeature_var&,int): Gets the intersection at a given index.
o GetIntersectionComputation(CATBoolean&): Queries whether intersection is computed or not.
o GetKeepHalfSpaceMode(CATBoolean&): Queries whether 'Keep elements in half space' mode is activated or not.
o GetKeptElem(CATIMmiMechanicalFeature_var&,int): Gets the kept feature at a given index.
o GetNbCuttingElem(int&): Gets the number of cutting features.
o GetNbElementsToKeep(int&): Gets the number of elements to keep.
o GetNbElementsToRemove(int&): Gets the number of elements to remove.
o GetOrientation(CATGSMOrientation&): Gets the orientation used to compute the split.
o GetOrientation(CATGSMOrientation&,int): Gets Orientation used to compute the split.
o GetOtherSide(CATIMmiMechanicalFeature_var&): Gets the other side.
o GetRemovedElem(CATIMmiMechanicalFeature_var&,int): Gets the removed feature at a given index.
o GetSupportElem(CATIMmiMechanicalFeature_var&): Gets the support of the curve to cut (optional).
o GetVolumeResult(CATBoolean&): Gets the type of the geometrical result.
o InvertOrientation(int): Inverts the orientation used to compute the split.
o RemoveCuttingElem(int): Removes a cutting feature at a given index.
o RemoveCuttingElem(CATIMmiMechanicalFeature_var&): Removes a cutting feature.
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 SetBothSidesMode(CATBoolean): Sets or unsets the computation of both sides.
o SetCuttingElem(CATIMmiMechanicalFeature_var): Sets the cutting feature (a point, a curve or a surface).
o SetCuttingElem(CATIMmiMechanicalFeature_var,int): Modifies the cutting feature at a given index (a point, a curve or a surface).
o SetElemToCut(CATIMmiMechanicalFeature_var): Sets the feature to cut (a curve or a surface).
o SetIgnoreNoIntersectingMode(CATBoolean): Sets or unsets the 'Ignore no intersecting elements' mode.
o SetIntersectionComputation(CATBoolean): Sets or unsets the computation of intersection.
o SetKeepHalfSpaceMode(CATBoolean): Sets or unsets the 'Keep elements in half space' mode.
o SetOrientation(CATGSMOrientation): Sets the orientation used to compute the split.
o SetOrientation(CATGSMOrientation,int): Sets the orientation used to compute the split.
o SetSupportElem(CATIMmiMechanicalFeature_var): Sets the support of the curve to cut (optional).
o SetVolumeResult(CATBoolean): Sets the type of the geometrical result.

Methods

o AddCuttingElem

public virtual AddCuttingElem(		`iElem`,
		`iOrientation`	`= CATGSMSameOrientation`)

Adds a cutting feature.

Parameters:

iElem: cutting feature
iOrientation: Orientation

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 GetBothSidesMode

public virtual GetBothSidesMode( oMode)

Queries whether both sides are computed or not.

Parameters:

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

o GetCuttingElem

public virtual GetCuttingElem( oElem)

Gets the cutting feature (a point, a curve or a surface).

Parameters:

oElem: cutting feature

o GetCuttingElem

public virtual GetCuttingElem(		`oElem`,
		`iRank`)

Gets the cutting feature at a given index (a point, a curve or a surface).

Parameters:

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

o GetElemToCut

public virtual GetElemToCut( oElem)

Gets the feature to cut (a curve or a surface).

Parameters:

oElem: feature to cut

o GetIgnoreNoIntersectingMode

public virtual GetIgnoreNoIntersectingMode( oMode)

Queries whether 'Ignore no intersecting elements' mode is activated or not.

Parameters:

oMode: Mode on (TRUE) or off (FALSE)

o GetIntersection

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

Gets the intersection at a given index.

Parameters:

oElem: Intersection
iRank: Index of one of the intersection features

o GetIntersectionComputation

public virtual GetIntersectionComputation( oMode)

Queries whether intersection is computed or not.

Parameters:

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

o GetKeepHalfSpaceMode

public virtual GetKeepHalfSpaceMode( oMode)

Queries whether 'Keep elements in half space' mode is activated or not.

Parameters:

oMode: Mode on (TRUE) or off (FALSE)

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 GetNbCuttingElem

public virtual GetNbCuttingElem( oNbCuttingElem)

Gets the number of cutting features.

Parameters:

oNbCuttingElem: Number of cutting features

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 GetOrientation

public virtual GetOrientation( oOrientation)

Gets the orientation used to compute the split.
Orientation specifies kept parts of cut feature.

When splitting a surface by a surface :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the cutting feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the cutting feature

When splitting a surface by a curve :
- If CATGSMSameOrientation: - If CATGSMInvertOrientation: Kept parts are specified by the inverse of the result of the cross product : normal(surface)^tangent(curve)

When splitting a curve by a point or a curve (without support specified):
- 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 splitting a curve on support:
- If CATGSMSameOrientation: Kept parts are specified by the result of the cross product : normal(support surface)^tangent(cutting curve)
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the result of the cross product : normal(support surface)^tangent(cutting curve)

When splitting a curve by a surface:
- If CATGSMSameOrientation: Kept parts are specified by the inverse of the normal to the surface
- If CATGSMInvertOrientation: Kept parts are specified by the normal to the surface

Parameters:

oOrientation: Orientation used to compute the split (CATGSMSameOrientation or CATGSMInverseOrientation)

o GetOrientation

public virtual GetOrientation(		`oOrientation`,
		`iRank`)

Gets Orientation used to compute the split.

Parameters:

oOrientation: Orientation
iRank: index of the cutting feature

o GetOtherSide

public virtual GetOtherSide( oElem)

Gets the other side.

Parameters:

oElem: Other side

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 GetSupportElem

public virtual GetSupportElem( oElem)

Gets the support of the curve to cut (optional).

Parameters:

oElem: Support surface

o GetVolumeResult

public virtual GetVolumeResult( oResultType)

Gets the type of the geometrical result.

Parameters:

oResultType: FALSE : Result type is surface TRUE : Result type is volume.(Option is effective only in case of volumes)

o InvertOrientation

public virtual InvertOrientation( iRank = 1)

Inverts the orientation used to compute the split.

Parameters:

iRank: index of the cutting feature

o RemoveCuttingElem

public virtual RemoveCuttingElem( iRank)

Removes a cutting feature at a given index.

Parameters:

iRank: index of the cutting feature

o RemoveCuttingElem

public virtual RemoveCuttingElem( iElem)

Removes a cutting feature.

Parameters:

iElem: cutting 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 SetBothSidesMode

public virtual SetBothSidesMode( iMode)

Sets or unsets the computation of both sides.

Parameters:

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

o SetCuttingElem

public virtual SetCuttingElem( const iElem)

Sets the cutting feature (a point, a curve or a surface).

Parameters:

iElem: new cutting feature

o SetCuttingElem

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

Modifies the cutting feature at a given index (a point, a curve or a surface). Use AddCuttingElem method to specify a new cutting element

Parameters:

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

o SetElemToCut

public virtual SetElemToCut( const iElem)

Sets the feature to cut (a curve or a surface).

Parameters:

iElem: new feature to cut

o SetIgnoreNoIntersectingMode

public virtual SetIgnoreNoIntersectingMode( iMode)

Sets or unsets the 'Ignore no intersecting elements' mode.

Parameters:

iMode: Mode on (TRUE) or off (FALSE)

o SetIntersectionComputation

public virtual SetIntersectionComputation( iMode)

Sets or unsets the computation of intersection.

Parameters:

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

o SetKeepHalfSpaceMode

public virtual SetKeepHalfSpaceMode( iMode)

Sets or unsets the 'Keep elements in half space' mode.

Parameters:

iMode: Mode on (TRUE) or off (FALSE)

o SetOrientation

public virtual SetOrientation( iOrientation)

Sets the orientation used to compute the split.
Orientation specifies kept parts of cut feature.

When splitting a surface by a surface :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the cutting feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the cutting feature

When splitting a surface by a curve :
- If CATGSMSameOrientation: Kept parts are specified by the result of the cross product : normal(surface)^tangent(curve)
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the result of the cross product : normal(surface)^tangent(curve)

When splitting a curve (without support specified):
- 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 splitting a curve on support:
- If CATGSMSameOrientation: Kept parts are specified by the result of the cross product : normal(support surface)^tangent(cutting curve)
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the result of the cross product : normal(support surface)^tangent(cutting curve)

Parameters:

iOrientation: Orientation used to compute the split (CATGSMSameOrientation or CATGSMInverseOrientation)

o SetOrientation

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

Sets the orientation used to compute the split.

Parameters:

iOrientation: Orientation
iRank: index of the cutting feature

o SetSupportElem

public virtual SetSupportElem( const iElem)

Sets the support of the curve to cut (optional).

Parameters:

iElem: Support surface

o SetVolumeResult

public virtual SetVolumeResult( const iResultType)

Sets the type of the geometrical result.

Parameters:

iResultType: FALSE : Result type is surface TRUE : Result type is volume.(Option is effective only in case of volumes, requires GSO License).

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