All Frameworks Class Hierarchy This Framework Previous Next Indexes
MecModInterfaces Interface CATIGSMTool
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMTool
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMTool
Interface to manage a GSMTool feature.
Role: This interface is specific for a GSMTool feature.
A GSMTool feature is a mechanical feature which mainly aggregates surfacic features.
The surfacic features reference 0D, 1D, or 2D geometry. So, the GSMTool is a body sometimes
called surfacic body. There are two kinds of GSMTool feature:
The
GetType method enables you to difference them. Refer to the CAA V5 encyclopedia (Mechanical Modeler & Sketcher domain) for more details on the subject.
Each geometrical feature inside the GSMTool have
the same "weight" as the solid body itself (
CATIMechanicalTool ). In other words, it has its own topological result and it is not automatically operated with a feature of the
same type.
The
CATIBodyRequest interface enables you to retrieve all the geometrical features which are included into the surfacic body.
The
CATIMechanicalRootFactory enables you to create a GSMTool and the
CATIPartRequest interface enables you to retrieve them.
Method Index
- o
AutoSortComponents(int)
- Automatical sort of components inside the surfacic body.
- o
GetType(int&)
- Retrieves the type of the surfacic body.
- o
IsPrivate(int&)
- Retrieves the private mode of the surfacic body.
- o
SetPrivate(int)
- Sets in private mode the surfacic body.
- o
SetType(int)
- Sets the type of the surfacic body.
Methods
o AutoSortComponents
public virtual HRESULT AutoSortComponents( | int | iMode | =0) =0 |
-
Automatical sort of components inside the surfacic body.
Role:
This service automatically sorts the surfacic body components respecting Parents/Children links.
- Parameters:
-
- iMode
- Default mode (0), only direct children are sorted. if iMode equals to 1, all sub-surfacic bodies
are sorted too.
- Returns:
- It can return E_FAIL if there is a update cycle.
o GetType
public virtual HRESULT GetType( | int& | oType) =0 |
-
Retrieves the type of the surfacic body.
- Parameters:
-
- oType
- The type of the surfacic body
Legal Values:
- 0: Geometrical Set
- 1: Ordered Geometrical Set
o IsPrivate
public virtual HRESULT IsPrivate( | int& | oMode) =0 |
-
Retrieves the private mode of the surfacic body.
- Parameters:
-
- oMode
- The private mode. The value is only available if the body is private. In this case, the
value is 1.
- Returns:
- The legal values are:
- S_OK The surfacic body is private
- E_FAIL otherwise
o SetPrivate
public virtual HRESULT SetPrivate( | int | iMode | =1) =0 |
-
Sets in private mode the surfacic body.
Role:
If a surfacic body is private, it means that it can be put as current feature, the user cannot
add or remove object inside. All manipulations inside this body should be done by code.
Use this capability if you want to create your own surfacic body.
- Parameters:
-
- iMode
- The private mode. The legal values are:
- 1 to set as private status
- 0 to set as public status
o SetType
public virtual HRESULT SetType( | int | iType) =0 |
-
Sets the type of the surfacic body.
- Parameters:
-
- iType
- The type of the surfacic body
Legal Values:
- 0: Geometrical Set
- 1: Ordered Geometrical Set
- Returns:
- The legal values are:
- S_OK The type of the surfacic body has been changed successfully
- E_FAIL The type of the surfacic body has not been changed since
it is forbidden by aggregation rules due to the body containt
This object is included in the file: CATIGSMTool.h
If needed, your Imakefile.mk should include the module: CATMecModInterfaces