All Frameworks Class Hierarchy This Framework Previous Next Indexes
MecModInterfaces Interface CATIPrtProceduralView
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPrtProceduralView
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPrtProceduralView
Interface to insert and reorder a solid feature into a procedural body.
Role: A procedural body, see the CATIMechanicalTool interface, is a body which contains solid features involved in the procedural view
of the body. The solid feature (
CATIShapeFeatureProperties ) participates to the global topological result of
the federating body in which it is instanciated. It is plugged in a "spine" and
is automatically involved in a boolean operation with the previous solid feature. The
CATIBodyRequest interface enables you to retrieve the result of this procedural body.
This interface is available for the features which can be set in a procedural body.
It enables you to:
Method Index
- o
InsertInProceduralView(CATISpecObject_var&)
- Inserts a solid feature into a procedural body.
- o
Reorder(CATISpecObject_var&)
- Relocates a solid feature in the procedural body.
Methods
o InsertInProceduralView
public virtual void InsertInProceduralView( | const CATISpecObject_var& | iDestination | = NULL_var )=0 |
-
Inserts a solid feature into a procedural body.
Role:This method enables to insert a solid feature into a procedural body. If the
feature already exists in a Body or Solid Body, use the
Reorder method to move it.
- Parameters:
-
- iDestination
- The position of the feature into the procedural body depends on this argument:
- It is a Body or Solid Body: the feature is set at the first position in the
Body or Solid Body.
- It is a solid feature: the feature is set after iDestination
- It is NULL_var (the default value): iDestination is automatically valuated with
the "in work object" feature. You set it thanks to the
CATIPrtPart.SetCurrentFeature, method and you retrieve it thanks to the
CATIPrtPart.GetCurrentFeature method. If the "in work object" is a Body or Solid Body, the insertion will take place in last
position of the Body or Solid Body.
If iDestination or the "In work object" feature is not valid, the InsertInProceduralView
method will throw
CATInternalError exceptions.
o Reorder
public virtual void Reorder( | const CATISpecObject_var& | iDestination) = 0 |
-
Relocates a solid feature in the procedural body.
Role:This method enables you to move a solid feature, already existing
into a procedural body, at another position.
If the destination for reorder reveals inappropriate, a new destination can sometimes
be redefined automatically.
- Parameters:
-
- iDestination
- The position of the feature into the procedural body depends on this argument:
- It is a Body or Solid Body: the feature is set at the first position in the
Body or Solid Body.
- It is a solid feature: the feature is set after iDestination
- It is NULL_var: iDestination is automatically valuated with
the "in work object" feature. You set it thanks to the
CATIPrtPart.SetCurrentFeature, method and you retrieve it thanks to the
CATIPrtPart.GetCurrentFeature method.
If iDestination or the "in work object" feature is not valid, the Reorder
method will throw
CATInternalError exceptions.
This object is included in the file: CATIPrtProceduralView.h
If needed, your Imakefile.mk should include the module: CATMecModInterfaces