All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDraftingGenUseItf Interface CATIDftGenViewFactory

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

interface CATIDftGenViewFactory

This interface contains methods to create generative drafting views.
Role: This interface is implemented by sheet object.

Method Index

o CreateAuxiliaryView(double*,CATMathDirection,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*,double*): CreateAuxiliaryView.
o CreateAuxiliaryViewFrom3DFace(double*,CATOmbObjectInContext*,CATOmbObjectInContext*,CATMathDirection&,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*,double*): CreateAuxiliaryViewFrom3DFace.
o CreateDetailViewAlone(double*,CATDftDetailType,CATISktUseSketch*,CATMathDirection,CATIUnknownList*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateDetailViewAlone.
o CreateDetailViewWithCircle(double*,CATDftDetailType,double*,double,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateDetailViewWithCircle.
o CreateDetailViewWithProfile(double*,CATDftDetailType,CATListPtrCATMathPoint2D,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateDetailViewWithProfile.
o CreateFrontView(double*,CATMathPlane,CATIUnknownList*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateFrontView.
o CreateIsometricView(double*,CATMathPlane,CATIUnknownList*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateIsometricView.
o CreateProjectionView(double*,CATDftViewType,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateProjectionView.
o CreateProjectionViewAlone(double*,CATDftViewType,CATMathPlane,CATIUnknownList*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateProjectionViewAlone.
o CreateSectionView(double*,CATDftSectionType,CATListPtrCATMathPoint2D,CATMathDirection,CATIDftView*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateSectionView.
o CreateSectionViewAlone(double*,CATDftSectionType,CATMathPlane*,CATISktUseSketch*,CATMathDirection,CATIUnknownList*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateSectionViewAlone.
o CreateSectionViewFrom3DFace(double*,CATDftSectionType,CATOmbObjectInContext*,CATOmbObjectInContext*,CATMathDirection&,CATIDftView**,CATUnicodeString,CATMathPoint*,CATBoolean,CATDftGenViewProperties*): CreateSectionViewFrom3DFace.
o CreateSectionViewFrom3DSketch(double*,CATDftSectionType,CATOmbObjectInContext*,CATMathDirection&,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateSectionViewFrom3DSketch.
o CreateUnfoldedView(double*,CATMathPlane,CATOmbObjectInContext*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateUnfoldedView.
o CreateViewFrom3D(double*,CATOmbObjectInContext*,CATIDftView**,CATUnicodeString,CATBoolean,CATDftGenViewProperties*): CreateViewFrom3D.

Methods

o CreateAuxiliaryView

public virtual CreateAuxiliaryView(	`iptOrigin`,
	`iDir`,
	`ipiDftMotherView`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`,
	`iptCallout`	`= NULL`)

CreateAuxiliaryView.
Role: This method creates an auxiliary view from a reference view (DftAuxiliaryView type).

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iDir: [in] The direction of projection of the view: This direction must be contained in the plane of the reference view.
ipiDftMotherView: [in] Pointer on the reference view.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new projection view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.
iptCallout[2]: [in] Coordinates in the sheet of the middle of the callout.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateAuxiliaryViewFrom3DFace

public virtual CreateAuxiliaryViewFrom3DFace(	`iptOrigin`,
	`ip3DFace`,
	`ip3DBody`,
	`iDir`,
	`ipiDftMotherView`,
	`oppiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`ipGenProperties`	`= NULL`,
	`iptCallout`	`= NULL`)

CreateAuxiliaryViewFrom3DFace.
Role: This method creates an auxiliary view using a 3D Face.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
ip3DFace: [in] The 3D pointed body element.
ip3DBody: [in] The 3D pointed face element.
iDir: [in] The direction of projection of the view: This direction must be perpendicular to the Face.
ipiDftMotherView: [in] Pointer on the reference view.
oppiDftView: [out, CATBaseUnknown#Release] Pointer on the new auxiliary view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
ipGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties.
iptCallout[2]: [in] Coordinates in the sheet of the middle of the callout.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateDetailViewAlone

public virtual CreateDetailViewAlone(	`iptOrigin`,
	`iViewType`,
	`iSketch`,
	`iDir`,
	`iListLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateDetailViewAlone.
Role: This method creates a standalone detail view without reference view.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view (DftGenRelimit3D, DftGenQuick).
iSketch: [in] The cutting profile is defined by a sketch containing the geometry's description of the detail profile (lines or circle). This sketch is created by the user and will be agregated by the resulting section view. If the method succeeds, the skecth mustn't be deleted.
iDir: [in] The direction of projection of the view: This direction must be perpendicular to the skecth.
iListLink: [in] The list of 3D pointed elements.

opiDftView

[out, CATBaseUnknown#Release] Pointer on the new detail view.

iViewStyle

[in] The name of the view style to take into account if different from "".

iComputeUpdate

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

iGenProperties

[in] A pointer on a CATDftGenViewProperties class in order to specify properties.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateDetailViewWithCircle

public virtual CreateDetailViewWithCircle(	`iptOrigin`,
	`iViewType`,
	`iCenter`,
	`iRadius`,
	`ipiDftMotherView`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateDetailViewWithCircle.
Role: This method creates a detail view defined with a circle, from a reference view.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view (DftGenRelimit3D, DftGenQuick).
iCenter: [in] Coordinates of the circle centre.
iRadius: [in] Radius of the circle centre.
iListOfPoints: [in] The parameter role...
ipiDftMotherView: [in] Pointer on the reference view.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new detail view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateDetailViewWithProfile

public virtual CreateDetailViewWithProfile(	`iptOrigin`,
	`iViewType`,
	`iListOfPoints`,
	`ipiDftMotherView`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateDetailViewWithProfile.
Role: This method creates a detail view defined with a profile, from a reference view.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view (DftGenRelimit3D, DftGenQuick).
iListOfPoints: [in] List of 2D points defining the detail profile.
ipiDftMotherView: [in] Pointer on the reference view.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new detail view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateFrontView

public virtual CreateFrontView(	`iptOrigin`,
	`iProjPlane`,
	`iListLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateFrontView.
Role: This method creates a front view.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iProjPlane: [in] The projection plane of the view.
iListLink: [in] The list of 3D pointed elements.

opiDftView

[out, CATBaseUnknown#Release] Pointer on the new front view.

iViewStyle

[in] The name of the view style to take into account if different from "".

iComputeUpdate

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

iGenProperties

[in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateIsometricView

public virtual CreateIsometricView(	`iptOrigin`,
	`iProjPlane`,
	`iListLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateIsometricView.
Role: This method creates an isometric view.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iProjPlane: [in] The projection plane of the view.
iListLink: [in] The list of 3D pointed elements.

opiDftView

[out, CATBaseUnknown#Release] Pointer on the new isometric view.

iViewStyle

[in] The name of the view style to take into account if different from "".

iComputeUpdate

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

iGenProperties

[in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateProjectionView

public virtual CreateProjectionView(	`iptOrigin`,
	`iViewType`,
	`ipiDftMotherView`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateProjectionView.
Role: This method creates a projection view from a reference view.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the projection view (DftLeftView, DftRightView, DftTopView,...). Use CreateAuxiliaryView in order to create an auxiliary view.
ipiDftMotherView: [in] Pointer on the reference view.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new projection view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateProjectionViewAlone

public virtual CreateProjectionViewAlone(	`iptOrigin`,
	`iViewType`,
	`iProjPlane`,
	`iListLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateProjectionViewAlone.
Role: This method creates a standalone projection view without reference view.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the projection view (DftLeftView, DftRightView, DftTopView, DftAuxiliaryView,...).
iProjPlane: [in] The projection plane of the view.
iListLink: [in] The list of 3D pointed elements.

opiDftView

[out, CATBaseUnknown#Release] Pointer on the new projection view.

iViewStyle

[in] The name of the view style to take into account if different from "".

iComputeUpdate

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

iGenProperties

[in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateSectionView

public virtual CreateSectionView(	`iptOrigin`,
	`iViewType`,
	`iListOfPoints`,
	`iDir`,
	`ipiDftMotherView`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateSectionView.
Role: This method creates a section view from a reference view.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view (Section, Cut, SectionAligned,...).
iListOfPoints: [in] List of 2D points defining the section profile.
iDir: [in] The direction of projection of the view: This direction must be contained in the plane of the reference view and must be: Perpandicular to the first line of the profile.
ipiDftMotherView: [in] Pointer on the reference view.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new section view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateSectionViewAlone

public virtual CreateSectionViewAlone(	`iptOrigin`,
	`iViewType`,
	`iCuttingPlane`,
	`iSketch`,
	`iDir`,
	`iListLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateSectionViewAlone.
Role: This method creates a standalone section view without reference view.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view (Section, Cut, SectionAligned,...).
iCuttingPlane: [in] If NULL, the next parameter (iSketch) must be valuated. If not NULL, the created section view is defined according to the 3D plane.
iSketch: [in] If NULL, the previous parameter (iCuttingPlane) must be valuated. If not NULL, the cutting profile is defined by a sketch containing the geometry's description of the section profile (lines). This sketch is created by the user and will be agregated by the resulting section view. If the method succeeds, the skecth mustn't be deleted.
iDir: [in] The direction of projection of the view, If iSkecth valuated : This direction must be parallel to the skecth and must be: Perpandicular to the first line of the profile. If iCuttingPlane valuated : This direction is not taken into account. The projection direction is defined by the cutting plane normal.
iListLink: [in] The list of 3D pointed elements.

opiDftView

[out, CATBaseUnknown#Release] Pointer on the new section view.

iViewStyle

[in] The name of the view style to take into account if different from "".

iComputeUpdate

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

iGenProperties

[in] A pointer on a CATDftGenViewProperties class in order to specify properties.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateSectionViewFrom3DFace

public virtual CreateSectionViewFrom3DFace(	`iptOrigin`,
	`iViewType`,
	`ip3DFace`,
	`ip3DBody`,
	`iDir`,
	`oppiDftView`,
	`iViewStyle`,
	`ipLimitPoints`	`= NULL`,
	`iComputeUpdate`	`= TRUE`,
	`ipGenProperties`	`= NULL`)

CreateSectionViewFrom3DFace.
Role: This method creates a standalone Section view without reference view using 3D Face.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view .
ipi3DBody: [in] The 3D pointed face element.
ipi3DFace: [in] The 3D pointed body element.
iDir: [in] The direction of projection of the view: This direction must be perpendicular to the Face.
oppiDftView: [out, CATBaseUnknown#Release] Pointer on the new section view.
iViewStyle: [in] The name of the view style to take into account if different from "".
*ipLimitPoints: [in] The Limit Points These 2 points allow to determine the extremities of the profile
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
ipGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateSectionViewFrom3DSketch

public virtual CreateSectionViewFrom3DSketch(	`iptOrigin`,
	`iViewType`,
	`ip3DSketch`,
	`iDir`,
	`oppiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`ipGenProperties`	`= NULL`)

CreateSectionViewFrom3DSketch.
Role: This method creates a standalone Section view without reference view using 3D Sketch.

Parameters:

iptOrigin: [in] Coordinates of anchor point of the created view.
iViewType: [in] The type of the section view .
ipi3DSketch: [in] The 3D pointed Sketch element.
iDir: [in] The direction of projection of the view: This direction must be perpendicular to the skecth.
oppiDftView: [out, CATBaseUnknown#Release] Pointer on the new section view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
ipGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateUnfoldedView

public virtual CreateUnfoldedView(	`iptOrigin`,
	`iProjPlane`,
	`iLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateUnfoldedView.
Role: This method creates an unfolded view.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
iProjPlane: [in] The projection plane of the view.
iLink: [in] The 3D pointed elements.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new unfolded view.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o CreateViewFrom3D

public virtual CreateViewFrom3D(	`iptOrigin`,
	`i3DTPSViewLink`,
	`opiDftView`,
	`iViewStyle`,
	`iComputeUpdate`	`= TRUE`,
	`iGenProperties`	`= NULL`)

CreateViewFrom3D.
Role: This method creates a view from 3D.

Parameters:

iptOrigin[2]: [in] Coordinates of anchor point of the created view.
i3DTPSViewLink: [in] The 3D pointed TPS View.
opiDftView: [out, CATBaseUnknown#Release] Pointer on the new view from 3D.
iViewStyle: [in] The name of the view style to take into account if different from "".
iComputeUpdate: [in] TRUE : the view is updated. FALSE : the view is not updated. See CATIDftGenViewUpdate.
iGenProperties: [in] A pointer on a CATDftGenViewProperties class in order to specify properties. If NULL, default properties are used.

Returns:

S_OK : if the view has been correctly created.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

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