All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMmiUseFeaturize

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

interface CATIMmiUseFeaturize

Interface to create a BRep feature from a selecting object or to duplicate a BRep feature.
Role: All methods of this interface work with the following set of attribute:

If a method is called on a selecting object, it creates a BRep feature.
If a method is called on a BRep feature, it returns the BRep feature itself or a copy of this BRep feature, depending on the iMode parameter.

Duplication of the BRep feature is controlled by the following values:

MfNoDuplicateFeature, which is the default value, and
MfDuplicateFeature.

There are 2 ways to define the support, either through a mode, or a support:

Support definition of the BRep feature is also controlled by the following iMode values:
- MfInitialFeatureSupport, which is the default value for functional BRep features,
- MfSelectingFeatureSupport, which is the default value for relimited BRep features, and
- MfLastFeatureSupport.
On the other hand, a CATIMmiMechanicalFeature can be specified as the support of the BRep feature.
- The functional BRep feature points to this specified object.
- The relimited BRep feature points to the ResultOUT of this specified object.
When the specified support is a ResultOUT, the BRep feature points to the attribute that contains this ResultOUT.
Some Part Design features such as fillet or draft angle have a special behavior. The support becomes the ResultIN of the design feature in order to manage delete, deactive, reorder, cut and paste. The specified support also can be a spec attribute that holds a feature.

The iMode value

MfTemporaryBody, which is the default value, creates a BRep feature that is a handle on a shape feature. Such a BRep feature requires the shape feature to provide its own geometrical description.
MfPermanentBody creates an independant BRep feature that behaves like a curve or surface feature. Such a feature can be used as an input to other operators.

These values can be combined together according to the following syntax: CATMfFeaturizeMode iMode = MfNoDuplicateFeature | MfPermanentBody | MfLastFeatureSupport;.
Anyway, the application has to aggregate the BRep feature in the structure so that it is involved in data management processes: delete, cut, copy, paste, update.

Method Index

o Featurize(CATIMmiUseMfBRep_var&,CATMmrLimitationType): Creates a BRep feature.
o Featurize(CATIMmiUseMfBRep_var&,CATBaseUnknown_var&): Creates a BRep feature.
o Featurize(CATIMmiUseMfBRep_var&,CATMfFeaturizeMode,CATMmrLimitationType): Creates a BRep feature.
o Featurize(CATIMmiUseMfBRep_var&,CATMfFeaturizeMode,CATBaseUnknown_var&): Creates a BRep feature.

Methods

o Featurize

public virtual Featurize(		`oBRepFeature`,
		`iType`	`= CATMmrDefaultLimitationType`)

Creates a BRep feature.

Parameters:

oBRepFeature: [out] The created CATIMmiUseMfBRep feature.
iType: [in] The type of relimitation. If CATMmrDefaultLimitationType, the type of relimitation will be taken from the featurized object.

Returns:

S_OK: The feature is successfully created.
E_FAIL: An error occured.

o Featurize

public virtual Featurize(		`oBRepFeature`,
	const	`iSupport`)

Creates a BRep feature.

Parameters:

oBRepFeature: [out] The created CATIMmiUseMfBRep feature.
iSupport: The explicit support.

Returns:

S_OK: The feature is successfully created.
E_FAIL: An error occured.

o Featurize

public virtual Featurize(		`oBRepFeature`,
	const	`iMode`,
		`iType`	`= CATMmrDefaultLimitationType`)

Creates a BRep feature.

Parameters:

oBRepFeature

[out] The created CATIMmiUseMfBRep feature.

iMode

The creation mode.
Legal values:

MfNoDuplicateFeature,
MfDuplicateFeature,
MfInitialFeatureSupport,
MfSelectingFeatureSupport,
MfLastFeatureSupport,
MfTemporaryBody,
MfPermanentBody,
MfFeaturizeIntersection,
MfFeaturizeC1Intersection.

iType

[in] The type of relimitation. . If CATMmrDefaultLimitationType, the type of relimitation will be taken from the featurized object.

Returns:

S_OK: The feature is successfully created.
E_FAIL: An error occured.

o Featurize

public virtual Featurize(		`oBRepFeature`,
	const	`iMode`,
	const	`iSupport`	`= NULL_var`)

Creates a BRep feature.

Parameters:

oBRepFeature

[out] The created CATIMmiUseMfBRep feature.

iMode

The creation mode.
Legal values:

MfNoDuplicateFeature,
MfDuplicateFeature,
MfInitialFeatureSupport,
MfSelectingFeatureSupport,
MfLastFeatureSupport,
MfTemporaryBody,
MfPermanentBody,
MfFeaturizeIntersection,
MfFeaturizeC1Intersection.

iSupport

The explicit support.

Returns:

S_OK: The feature is successfully created.
E_FAIL: An error occured.

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