All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDraftingGenUseItf Interface CATIDftGenViewModification

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftGenViewModification

This interface contains methods to modify generative drafting views.
Role: This interface is implemented by hlrview object (applicative extension of the view).

Method Index

o AddBreakout(CATListPtrCATMathPoint2D,CATMathPlane,CATBoolean): Adds a breakout.
o AddBroken(double*,double*,CATBoolean,CATBoolean,CATBoolean): Adds a break.
o AddClippingBox(CATMathPoint,CATMathPoint,CATMathPoint,CATMathPoint,CATBoolean): Adds a clipping box.
o AddClippingWithCircle(CATDftDetailType,double*,double,CATBoolean): Adds a clipping with circle.
o AddClippingWithProfile(CATDftDetailType,CATListPtrCATMathPoint2D,CATBoolean): Adds a clipping with profile.
o ApplyBreakoutTo(CATIDftView*,CATBoolean): Applies breakout to a view.
o ApplyClippingBoxTo(CATIDftView*,CATBoolean): Applies clipping box to a view.
o ApplyLinksTo(CATIDftView*,CATBoolean): Applies links to a view.
o ApplyOverloadPropertiesTo(CATIDftView*,CATBoolean): Applies overload properties to a view.
o ModifyGenViewProperties(CATDftGenViewProperties*,CATBoolean): Modifies generative view properties.
o ModifyLinks(CATIUnknownList*,CATBoolean): Modifies links.
o ModifyProjectionPlane(CATMathPlane,CATBoolean): Modifies projection plane.
o RemoveBox3D(): Removes a box3D operator in the view.
o SetBox3DOptions(CATDrwGenBox3DType,CATDrwGenBox3DMode): Sets parameters on a box operator.
o UnBreak(CATBoolean): Removes break.
o UnBreakout(CATBoolean): Removes breakout.
o UnClip(CATBoolean): Removes clip.

Methods

o AddBreakout

public virtual AddBreakout(	`iListOfPoints`,
	`iDepthPlane`,
	`iComputeUpdate`	`= TRUE`)

Adds a breakout.
Role: this method adds a breakout on a generative view.

Parameters:

iListOfPoints: [in] List of 2D points defining the breakout profile.
iDepthPlane: [in] A 3D plane (parallel to view's projection plane) defining the breakout depth.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the breakout has been correctly added.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o AddBroken

public virtual AddBroken(	`iFirstPoint`,
	`iSecondPoint`,
	`ibVertical`	`= FALSE`,
	`iComputeUpdate`	`= TRUE`,
	`ibArePointsInUnbrokenView`	`= TRUE`)

Adds a break.
Role: this method adds a break on a generative view.

Parameters:

iFirstPoint[2]: [in] Coordinates of anchor point of the first limit of the break.
iSecondPoint[2]: [in] Coordinates of anchor point of the second limit of the break.
iVertical: [in] defines if the break is vertical or horizontal.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
ibArePointsInUnbrokenView: [in] eg. Original Unbroken View - user has to create 2 broken operators at points 1) (100, 0) & (300, 0)and 2) (400, 0) & (500, 0) __________ ________________________________ __________ __________ __________ | | | | | | | | | | | | |__________|________________________________|__________|__________|__________| (100, 0) (300, 0) (400, 0) (500, 0) After 1st break at (100, 0) & (300, 0) the resulting view is as follows __________ __________ __________ __________ | || | | | | || | | | |__________||__________|__________|__________| (100, 0) (205,0) (305,0) Points (205, 0) & (305, 0) represent the points (400, 0) & (500, 0) respectively in unbroken view. TRUE : the points are passed corresponding to the unbroken view (irrespective of whether a broken operator is present on the view or not). eg.In the above case user has to pass the points as (400, 0) & (500, 0) to create the second broken operator. FALSE : the points are passed corresponding to the current view (irrespective of whether a broken operator is present on the view or not). eg. In the above case user has to pass the points as (205, 0) & (305, 0) to create the second broken operator. If the user passes points as (400, 0) & (500, 0), the points will be out of the bounding box of the current view. In both the cases the resulting view will be the same as follows __________ __________ __________ | || || | | || || | |__________||__________||__________| (100, 0) (205,0)

Returns:

S_OK : if the break has been correctly added.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o AddClippingBox

public virtual AddClippingBox(	`iFirstBasePoint`,
	`iSecondBasePoint`,
	`iThirdBasePoint`,
	`iDepthPoint`,
	`iComputeUpdate`	`= TRUE`)

Adds a clipping box.
Role: this method adds a cclipping on a generative view.

Parameters:

iFirstBasePoint: [in] The first point of the clipping box base.
iSecondBasePoint: [in] The second point of the clipping box base.
iThirdBasePoint: [in] The third point of the clipping box base.
iDepthPoint: [in] A point defining the depth of the clipping box.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the clipping box has been correctly added.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o AddClippingWithCircle

public virtual AddClippingWithCircle(	`iViewType`,
	`iCenter`,
	`iRadius`,
	`iComputeUpdate`	`= TRUE`)

Adds a clipping with circle.
Role: this method adds a circular clipping on a generative view.

Parameters:

iViewType: [in] Type of the clipping (DftGenRelimit3D, DftGenQuick).
iCenter[2]: [in] Coordinates of the circle centre.
iRadius: [in] Radius of the circle centre.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the clipping has been correctly added.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o AddClippingWithProfile

public virtual AddClippingWithProfile(	`iViewType`,
	`iListOfPoints`,
	`iComputeUpdate`	`= TRUE`)

Adds a clipping with profile.
Role: this method adds a polygonal clipping on a generative view.

Parameters:

iViewType: [in] Type of the clipping (DftGenRelimit3D, DftGenQuick).
iListOfPoints: [in] List of 2D points defining the clipping profile.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the clipping has been correctly added.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ApplyBreakoutTo

public virtual ApplyBreakoutTo(		`ipiDftView`,
		`iComputeUpdate`	`= TRUE`)

Applies breakout to a view.
Role: this method applies breakout(s) contained in a view to another one.

Parameters:

ipiDftView: [in] The view on which breakout(s) will be applied.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the breakout has been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ApplyClippingBoxTo

public virtual ApplyClippingBoxTo(		`ipiDftView`,
		`iComputeUpdate`	`= TRUE`)

Applies clipping box to a view.
Role: this method applies clipping box contained in a view to another one.

Parameters:

ipiDftView: [in] The view on which breakout(s) will be applied.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the clipping box has been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ApplyLinksTo

public virtual ApplyLinksTo(		`ipiDftView`,
		`iComputeUpdate`	`= TRUE`)

Applies links to a view.
Role: this method applies link(s) of a view to another one.

Parameters:

ipiDftView: [in] The view on which link(s) will be applied.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the links have been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ApplyOverloadPropertiesTo

public virtual ApplyOverloadPropertiesTo(		`ipiDftView`,
		`iComputeUpdate`	`= TRUE`)

Applies overload properties to a view.
Role: this method applies overload properties of a view to another one.

Parameters:

ipiDftView: [in] The view on which overload properties will be applied.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the overload properties have been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ModifyGenViewProperties

public virtual ModifyGenViewProperties(		`iNewGenProperties`,
		`iComputeUpdate`	`= TRUE`)

Modifies generative view properties.
Role: This method allows to apply properties to a generative view.

Parameters:

iNewGenProperties: [in] A pointer on the CATDftGenViewProperties class defining properties of the view.
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if properties have been correctly modified.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ModifyLinks

public virtual ModifyLinks(		`iListNewLinks`,
		`iComputeUpdate`	`= TRUE`)

Modifies links.
Role: this method applies new link(s) to 3D on a generative view.

Parameters:

iListNewLinks: [in] The list of 3D pointed elements.

iComputeUpdate

[in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the links have been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o ModifyProjectionPlane

public virtual ModifyProjectionPlane(		`iNewProjectionPlane`,
		`iComputeUpdate`	`= TRUE`)

Modifies projection plane.
Role: this method applies a new projection plane on a generative view.

Parameters:

iNewProjectionPlane: [in] The new projection plane
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if the new projection plane has been correctly applied.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o RemoveBox3D

public virtual RemoveBox3D(

)

Removes a box3D operator in the view.

Returns:
S_OK: if the operation succeeded,
E_FAIL: if an unspecified failure occurred.

o SetBox3DOptions

public virtual SetBox3DOptions(	const	`iClippingType`	`=ClippingByBox`,
	const	`iClippingMode`	`=Relimit`)

Sets parameters on a box operator.

Parameters:

iClippingType: (box, slice or back clipping plane)
iClippingMode: ** NOT IMPLEMENTED **

Returns:

S_OK

if operation succeeded.

E_FAIL

if a box does not exist on the view

o UnBreak

public virtual UnBreak( iComputeUpdate = TRUE)

Removes break.
Role: this method removes all breaks contained in a generative view.

Parameters:

iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if breaks have been correctly removed.
E_FAIL : if the operation failed.

o UnBreakout

public virtual UnBreakout( iComputeUpdate = TRUE)

Removes breakout.
Role: this method removes all breakouts contained in a generative view.

Parameters:

iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if breakouts have been correctly removed.
E_FAIL : if the operation failed.

o UnClip

public virtual UnClip( iComputeUpdate = TRUE)

Removes clip.
Role: this method removes clipping applied to a generative view.

Parameters:

iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.

Returns:

S_OK : if clipping has been correctly removed.
E_FAIL : if the operation failed.

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