Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface 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(CATIDftView_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(CATIDftView_var&,CATLISTV(CATBaseUnknown_var)&): Retrieves the list of elements belonging to a view which provide the construction lines.
o GetMyView(CATIDftView_var&): Retrieves the main view.
o RemoveAuxElem(CATBaseUnknown_var&,int): Removes construction lines coming from a single element.
o RemoveAuxView(CATIDftView_var&): Removes all construction lines between a view and an other.

Methods

o AddAuxElem

public virtual AddAuxElem(	const	`iElem`,
		`update`	`=1`)

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:

o AddAuxView

public virtual AddAuxView( const iView)

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:

o GetListOfAuxiliaryViews

public virtual GetListOfAuxiliaryViews( oList)

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 CATIDftView_var.

Returns:

S_OK : Method correctly executed. E_FAIL : Method execution failed.

See also:

o GetListOfElems

public virtual GetListOfElems(	const	`iView`,
		`oList`)

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 GetMyView( oView)

Retrieves the main view. (should be the view that implements this interface).

Parameters:

oView: [out] the main view

Returns:

S_OK : Method correctly executed. E_FAIL : Method execution failed.

o RemoveAuxElem

public virtual RemoveAuxElem(	const	`iElem`,
		`update`	`=1`)

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 RemoveAuxView( const iView)

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:

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