All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDrwConstructionLines
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDrwConstructionLines
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwConstructionLines
Interface implemented by views.
Role: It allows to build or destroy construction lines between views.
Method Index
- o
AddAuxElem(CATBaseUnknown_var&,int)
- Builds construction lines between a view and a single element.
- o
AddAuxView(CATIView_var&)
- Builds all construction lines between a view and an other one.
- o
GetListOfAuxiliaryViews(CATLISTV(CATBaseUnknown_var)&)
- Retrieves the auxiliary views which provide the construction lines.
- o
GetListOfElems(CATIView_var&,CATLISTV(CATBaseUnknown_var)&)
- Retrieves the list of elements belonging to a view which provide the construction lines.
- o
GetMyView(CATIView_var&)
- Retrieves the main view.
- o
RemoveAuxElem(CATBaseUnknown_var&,int)
- Removes construction lines coming from a single element.
- o
RemoveAuxView(CATIView_var&)
- Removes all construction lines between a view and an other.
Methods
o AddAuxElem
-
Builds construction lines between a view and a single element.
- Parameters:
-
- iElem
- [in] the single element (a geometry)
- update
- [in] if you have several elem to compute together , use update = 0 for all the elems except the last one. (That must be more efficient)
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed. (iElem not correct).
- See also:
- GetMyView
o AddAuxView
public virtual HRESULT AddAuxView( | const CATIView_var& | iView)=0 |
-
Builds all construction lines between a view and an other one.
- Parameters:
-
- iView
- [in] the "other" view
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed. (iView same as GetMyView() or not correct).
- See also:
- GetMyView
o GetListOfAuxiliaryViews
-
Retrieves the auxiliary views which provide the construction lines.
- Parameters:
-
- oList
- [out] the list of other views that have construction lines with the main view
note :the objects contained in the returned list are in fact CATIView_var.
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed.
- See also:
- GetMyView
o GetListOfElems
-
Retrieves the list of elements belonging to a view which provide the construction lines.
- Parameters:
-
- iView
- [in] the view that contains the elements
- oList
- [out] the list of elements (geometry) that provide construction lines note :the objects contained in the returned list are in fact CATI2DWFGeomtry_var.
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed.
o GetMyView
public virtual HRESULT GetMyView( | CATIView_var& | oView) const=0 |
-
Retrieves the main view. (should be the view that implements this interface).
- Parameters:
-
- oView
- [out] the main view
o RemoveAuxElem
-
Removes construction lines coming from a single element.
- Parameters:
-
- iElem
- [in] the single element (a geometry)
- update
- [in] if you have several elem to compute together , use update = 0 for all the elems except the last one. (That must be more efficient)
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed. (iElem not correct).
o RemoveAuxView
public virtual HRESULT RemoveAuxView( | const CATIView_var& | iView)=0 |
-
Removes all construction lines between a view and an other.
- Parameters:
-
- iView
- [in] the "other" view
- Returns:
- S_OK : Method correctly executed.
E_FAIL : Method execution failed. (iView not already added).
- See also:
- GetMyView
This object is included in the file: CATIDrwConstructionLines.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces