CATMecModUseItf Interface CATIMmiUseBRepDecodeServices
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMmiUseBRepDecodeServices
Interface exposing services to create a selecting object from a topological cell.
Use CATMmiUseServicesFactory::CreateBRepDecodeServices to get the services component.
A CATIMmiUseBRepAccess is created from a CATCell.
A CATIMmiUseRSur is created from a CATFace.
A CATIMmiUseREdgeAccess is created from a .
A CATIMmiUseREdge is created from a CATEdge.
A CATIMmiUseBorderREdge is created from a CATEdge.
A CATIMmiUseWireREdge is created from a CATEdge.
A CATIMmiUseFVertexAccess is created from a CATVertex.
A CATIMmiUseFVertex is created from a CATVertex.
A CATIMmiUseBorderFVertex is created from a CATVertex.
A CATIMmiUseWireFVertex is created from a CATVertex.
A selecting object is not persistent.
Other methods create a persistent BRep feature from a selecting object.
- See also:
- , ,
Method Index
- o
DecodeAdjacents(CATListValCATIMmiUseBRepAccess_var&,int,CATListValCATIMmiUseBRepAccess_var&)
- Returns the adjacent selecting objects to the input list of selecting objects.
- o
DecodeAdjacents(CATListValCATIMmiUseBRepAccess_var&,CATIMmiUseGeometricalElement_var&,int,CATListValCATIMmiUseBRepAccess_var&)
- Returns the adjacent selecting objects to the input list of selecting objects.
- o
DecodeAxis(CATIMmiUseBRepAccess_var&,CATIMmiUseRSur_var&)
- Returns the axis selecting object from a surface selecting object.
- o
DecodeAxis(CATIMmiUseBRepAccess_var&,CATCell_var&,CATIMmiUseGeometricalElement_var&)
- Returns the axis selecting object from a topological cell and the topological body of a specified feature.
- o
DecodeCellInBody(CATIMmiUseBRepAccess_var&,CATCell_var&,CATBody_var&)
- Returns the selecting object from a topological cell in a topological body.
- o
DecodeCellInGeomElt(CATIMmiUseBRepAccess_var&,CATCell_var&,CATIMmiUseGeometricalElement_var&)
- Returns the selecting object from a topological cell and the topological body of a specified feature.
- o
DecodeCellInGeomElt(CATIMmiUseBRepAccess_var&,CATCell_var&,CATIMmiUseGeometricalElement_var&,CATMfBRepDecodeType,CATMfBRepSelectType)
- Returns the selecting object from a topological cell and the topological body of a specified feature.
- o
DecodeExtendedLabel(CATListValCATIMmiUseBRepAccess_var&,CATUnicodeString&,CATIMmiUseGeometricalElement_var&)
- Returns the selecting objects from information captured in the symbolic link of a connector.
- o
DecodeExtremity(CATIMmiUseBRepAccess_var&,CATIMmiUseRSur_var&)
- Returns the extremity selecting object from a surface selecting object.
- o
DecodeExtremity(CATIMmiUseBRepAccess_var&,CATCell_var&,CATIMmiUseGeometricalElement_var&)
- Returns the extremity selecting object from a topological cell and the topological body of a specified feature.
- o
DecodePlanarSubElement(CATIMmiUseBRepAccess_var&,CATIMmiUseRSur_var&)
- Returns the planar subelement selecting object from a surface selecting object.
- o
DecodePlanarSubElement(CATIMmiUseBRepAccess_var&,CATCell_var&,CATIMmiUseGeometricalElement_var&)
- Returns the planar subelement selecting object from a topological cell and the topological body of a specified feature.
- o
DecodeSymbolic(CATListValCATIMmiUseBRepAccess_var&,CATListValCATIMmiMechanicalFeature_var&,CATListOfCATUnicodeString&,CATListValCATIMmiMechanicalFeature_var&,CATIMmiUseGeometricalElement_var&)
- Returns the selecting objects from symbolic specifications.
Methods
o DecodeAdjacents
| public virtual DecodeAdjacents( | | iBrepsAppuis, |
| | iDimension, |
| | oBreps) |
-
Returns the adjacent selecting objects to the input list of selecting objects.
- Parameters:
-
- iBrepsAppuis
- [in] Either a list of face selecting objects,
or border edge selecting objects,
or border vertex selecting objects,
or wire edge selecting objects.
- iDimension
- [in] Topological dimension of the output list of selecting objects.
- oBreps
- [out] List of adjacent selecting objects to the input list of selecting objects.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeAdjacents
| public virtual DecodeAdjacents( | | iBrepsAppuis, |
| const | iFeature, |
| | iDimension, |
| | oBreps) |
-
Returns the adjacent selecting objects to the input list of selecting objects.
- Parameters:
-
- iBrepsAppuis
- [in] Either a list of face selecting objects,
or border edge selecting objects,
or border vertex selecting objects,
or wire edge selecting objects.
- iFeature
- [in] Search is performed in the scope of iFeature.
- iDimension
- [in] Topological dimension of the output list of selecting objects.
- oBreps
- [out] List of adjacent selecting objects to the input list of selecting objects.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeAxis
| public virtual DecodeAxis( | | oBRepAccess, |
| const | iRsur) |
-
Returns the axis selecting object from a surface selecting object.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iRsur
- [in] Surface selecting object.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeAxis
| public virtual DecodeAxis( | | oBRepAccess, |
| const | iCell, |
| const | iAssociatedFeature) |
-
Returns the axis selecting object from a topological cell and the topological body of a specified feature.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell.
- iAssociatedFeature
- [in] Feature owner of the topological body used to select the topological cell.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeCellInBody
| public virtual DecodeCellInBody( | | oBRepAccess, |
| const | iCell, |
| const | iBody) |
-
Returns the selecting object from a topological cell in a topological body.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell belonging to iBody.
- iBody
- [in] Topological body.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeCellInGeomElt
| public virtual DecodeCellInGeomElt( | | oBRepAccess, |
| const | iCell, |
| const | iAssociatedFeat) |
-
Returns the selecting object from a topological cell and the topological body of a specified feature.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell.
- iAssociatedFeat
- [in] Feature owner of the topological body used to select the topological cell.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeCellInGeomElt
| public virtual DecodeCellInGeomElt( | | oBRepAccess, |
| const | iCell, |
| | iAssociatedFeature, |
| const | iDecodeType, |
| const | iSelectType | = MfSimpleSelect) |
-
Returns the selecting object from a topological cell and the topological body of a specified feature.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell.
- iAssociatedFeature
- [in] Feature owner of the topological body used to select the topological cell.
- iDecodeType
- [in] Legal values:
MfDecodeAll, MfDecodeWire, MfDecodeShell, MfDecodeLump.
- iSelectType
- [in] Legal values:
MfForceSelect, MfSimpleSelect.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeExtendedLabel
| public virtual DecodeExtendedLabel( | | oList, |
| const | iMfExtendeLabel, |
| const | iFeature) |
-
Returns the selecting objects from information captured in the symbolic link of a connector.
- Parameters:
-
- oList
- [out] The list of selecting objects.
- iMfExtendeLabel
- [in] Label.
- iFeature
- [in] Feature owner of the topological body used to select the topological cell.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeExtremity
| public virtual DecodeExtremity( | | oBRepAccess, |
| const | iRsur) |
-
Returns the extremity selecting object from a surface selecting object.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iRsur
- [in] Surface selecting object.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeExtremity
| public virtual DecodeExtremity( | | oBRepAccess, |
| const | iCell, |
| const | iAssociatedFeature) |
-
Returns the extremity selecting object from a topological cell and the topological body of a specified feature.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell.
- iAssociatedFeature
- [in] Feature owner of the topological body used to select the topological cell.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodePlanarSubElement
| public virtual DecodePlanarSubElement( | | oBRepAccess, |
| const | iRsur) |
-
Returns the planar subelement selecting object from a surface selecting object.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iRsur
- [in] Surface selecting object.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodePlanarSubElement
| public virtual DecodePlanarSubElement( | | oBRepAccess, |
| const | iCell, |
| const | iAssociatedFeature) |
-
Returns the planar subelement selecting object from a topological cell and the topological body of a specified feature.
- Parameters:
-
- oBRepAccess
- [out] The selecting object.
- iCell
- [in] Topological cell.
- iAssociatedFeature
- [in] Feature owner of the topological body used to select the topological cell.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o DecodeSymbolic
| public virtual DecodeSymbolic( | | oList, |
| | iPrints, |
| | iKeys, |
| | iProfilElements, |
| const | iAssociatedFeature) |
-
Returns the selecting objects from symbolic specifications.
For example, the selecting object associated with the lateral face of Pad.3 extruded from Line.7,
on the solid after Fillet.7 is created with:
iPrints[1]=Pad.3,
iKeys[1]=MfKeyExtrudedFrom,
iProfilElements[1]=Line.7, and
iAssociatedFeature=Fillet.7.
Another example, the selecting object associated with the edge shared by
the lateral face of Pad.3 extruded from Line.7,
and by the top face of Pad.6 is created with:
iPrints[1]=Pad.3, iPrints[2]=Pad.6,
iKeys[1]=MfKeyExtrudedFrom, iKeys[2]=MfKeyTop,
iProfilElements[1]=Line.7,
iProfilElements[2]=NULL_var and
iAssociatedFeature=Fillet.7.
The selecting object associated with a vertex is specified with all its adjacent faces.
- Parameters:
-
- oList
- [out] The list of selecting objects.
- iPrints
- [in] List of shape features.
- iKeys
- [in] List of key words
Legal values:
MfKeyTop,
MfKeyBottom,
MfKeyExtrudedFrom,
MfKeyStart,
MfKeyEnd.
- iProfilElements
- [in] List of sketch elements.
- iAssociatedFeature
- Resolution is performed in the scope of iAssociatedFeature.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
This object is included in the file: CATIMmiUseBRepDecodeServices.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.