All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDftGenerSpec

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

interface CATIDftGenerSpec

Interface to specialize a generative drawing view.
Role: This interface to add operator(s) to specialize a generative drawing view or to retrieve informations about the view specialization.

A generative drawing view may be specialized as a :
- Detail view: to retrieve the detail view definition.
- Section or section cut view: to retrieve the section view definition.
- Broken view: to retrieve the break definition.
- Auxiliary view: to retrieve the projection definition.
- All views: to retrieve the projection plane definition.
- All views: to retrieve the coordinates of the projection of the centre of the 3D bounding box.
- All views: to set the coordinates of the projection of the centre of the 3D bounding box.
- All views: to retrieve the main links of the view.
Note 1: A view can cumulate several of these types. For example, a view can be altogether a section view and a broken view.
The callout defining the view, for auxiliary, section, and detail views:

Method Index

o CreateAlone3DSpaceClipping(CATDft3DSpaceClippingType): Creates a 3D Space clipping object (clipping not defined by a 3D object).
o Get3DSpaceClipping(CATOmbObjectInContext**): Gets the 3D object defining the 3D space clipping.
o Get3DSpaceClippingType(CATDft3DSpaceClippingType&): Gets the 3D space clipping object type.
o GetAxisSystem(CATOmbObjectInContext**): GetAxisSystem.
o GetBox3D(CATMathPoint*,CATMathPoint*,CATMathPoint*,CATMathPoint*): Retrieves box mathematical definition.
o GetBox3DOptions(CATDrwGenBox3DType&,CATDrwGenBox3DMode&): Gets parameters on a box operator.
o GetBreakViewInfo(CATMathVector2D&,CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)&,CATListOfDouble&,CATListOfDouble&): Retrieves the BreakView definition in the drawing view.
o GetDetailProfile(CATBoolean&,CATListPtrCATMathPoint2D&,double&): Returns geometric informations about profile for detail view.
o GetExtendedObject(IID&,IUnknown**): Get the extended object.
o GetGVSName(CATUnicodeString&): GetGVSName.
o GetGenViewLinks(CATIUnknownList**): Ges links of the view.
o GetGenViewLinks(IID&,CATIUnknownList**): Ges links of the view.
o GetGenViewProperties(CATDftGenViewProperties&): Gets View Properties.
o GetNbBreakouts(int*): Gets the number of breakouts contained in the view.
o GetNbBreaks(int*): Gets the number of breaks contained in the view.
o GetOriginCallout(CATIDrwCalloutAccess**): Gets the callout defining the view.
o GetPosition(double*,double*): Gets the position.
o GetProjectionPlane(CATMathPlane**): Gets the projection plane.
o GetProjectionProfile(CATMathPoint[2],CATMathDirection&): Returns geometric informations about profile for auxiliary view.
o GetSectionProfile(CATListPtrCATMathPoint2D&,int&,CATMathDirection&): Retrieves the section definition in the drawing view.
o IsClipped(): Checks if the view is a clipping view.
o IsClippedByBox(): Checks if the view contains a clipping box operator.
o Remove3DSpaceClipping(): Removes the 3D space clipping from the view.
o RemoveGVS(): RemoveGVS.
o Set3DSpaceClipping(CATOmbObjectInContext*): Creates or modifies a 3D Space clipping object (modify is 3D space clipping already existing).
o SetAxisSystem(CATOmbObjectInContext*): SetAxisSystem.
o SetGVSName(CATUnicodeString): SetGVSName.
o SetPosition(double,double): Sets the position.

Methods

o CreateAlone3DSpaceClipping

public virtual CreateAlone3DSpaceClipping( iSpaceClippingType)

Creates a 3D Space clipping object (clipping not defined by a 3D object).

Parameters:

iSpaceClippingType: The type of the 3D Space Clipping to be added to the view.

Returns:

S_OK : if the clipping is correctly created.
E_FAIL : if the operation fails.

o Get3DSpaceClipping

public virtual Get3DSpaceClipping( o3DSpaceClippingObject)

Gets the 3D object defining the 3D space clipping.

Parameters:

o3DSpaceClippingObject: [out] The link to the 3D object defining the Space Clipping.

Returns:

S_OK : if the clipping is correctly returned.
E_FAIL : if the operation fails.

o Get3DSpaceClippingType

public virtual Get3DSpaceClippingType( oSpaceClippingType)

Gets the 3D space clipping object type.

Parameters:

oSpaceClippingType: [out] Type of the 3D space clipping.

Returns:

S_OK : if the clipping type is correctly returned.
E_FAIL : if the operation fails.

o GetAxisSystem

public virtual GetAxisSystem( oAxisSystemLink)

GetAxisSystem. Retrieves the axis system definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oAxisSystemLink: [out, CATBaseUnknown#Release] The 3D pointed axis system.

Returns:

S_OK : if the view is linked with a 3D axis system.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the view is not linked with a 3D axis system.

o GetBox3D

public virtual GetBox3D(		`oPointA`,
		`oPointB`,
		`oPointC`,
		`oPointD`)

Retrieves box mathematical definition.

Parameters:

oPointA: The first point of the clipping box base.
oPointB: The second point of the clipping box base.
oPointC: The third point of the clipping box base.
oPointD: A point defining the depth of the clipping box.

Returns:

S_OK

if the operation succeeded,

E_INVALIDARG

if argument pointer NULL,

E_FAIL

if an unspecified failure occurred.

o GetBox3DOptions

public virtual GetBox3DOptions(		`oClippingType`,
		`oClippingMode`)

Gets parameters on a box operator.

Parameters:

oClippingType: (box, slice or back clipping plane)
oClippingMode: ** NOT IMPLEMENTED **

Returns:

S_OK

if operation succeeded.

E_FAIL

if a box does not exist on the view

o GetBreakViewInfo

public virtual GetBreakViewInfo(		`oVecDir`,
		`oListe1_skElem`,
		`oListe2_skElem`,
		`oTranslation1`,
		`oTranslation2`)

Retrieves the BreakView definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

ovecdir: Direction of break
oliste1_skElem: A list of sketch elements which describe the shape of first BrokenLines
oliste2_skElem: A list of double sketch elements which describe the shape of second BrokenLines
otranslation1: A list of double which describe translation associated to the shape of first BrokenLines
otranslation2: A list of double which describe translation associated to the shape of second BrokenLines

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetDetailProfile

public virtual GetDetailProfile(		`oIsCircular`,
		`oProfil`,
		`oRadius`)

Returns geometric informations about profile for detail view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oIsCircular: oIsCircular is true means profile is only defined by a circle.
oProfile: Profile defined by a list of points. if Profile is circular, there only one point in the list to return cirlce center.
oRadius: Radius of circle

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetExtendedObject

public virtual GetExtendedObject(	const	`iIID`,
		`oObject`)

Get the extended object.
Role: This method retrieves the extended object.

Parameters:

iIID: [in] The required interface.
oObject: [out, CATBaseUnknown#Release] The required object.

Returns:

S_OK : if the object has been correctly retrieved.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetGVSName

public virtual GetGVSName( oViewStyle)

GetGVSName. Retrieves the GVS name of the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oViewStyle: The GVS name.

Returns:

S_OK : if the view properties are defined from a GVS.
E_FAIL : if the view is not linked with a 3D axis system.

o GetGenViewLinks

public virtual GetGenViewLinks( oListNewLinks)

Ges links of the view.
Role: This method gives the list of 3D pointed elements.

Parameters:

oListNewLinks: [out, CATBaseUnknown#Release] The list of 3D pointed elements. This list contains CATOmbObjectInContext objects.

Returns:

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

o GetGenViewLinks

public virtual GetGenViewLinks(	const	`iIID`,
		`oListLinks`)

Ges links of the view.
Role: This method gives the list of 3D pointed elements.

Parameters:

iIID: [in] The required interface.
oListLinks: [out, CATBaseUnknown#Release] The list of 3D pointed elements.

Returns:

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

o GetGenViewProperties

public virtual GetGenViewProperties( oProperties)

Gets View Properties.
Role: Retrieves the properties of a generative view.

Parameters:

oProperties: [out] a CATDftGenViewProperties class containing the properties of the view.

Returns:

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

o GetNbBreakouts

public virtual GetNbBreakouts( oNumber)

Gets the number of breakouts contained in the view.

Parameters:

oNumber: [out] the number of breakouts

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetNbBreaks

public virtual GetNbBreaks( oNumber)

Gets the number of breaks contained in the view.

Parameters:

oNumber: [out] the number of breaks

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetOriginCallout

public virtual GetOriginCallout( oCallout)

Gets the callout defining the view.
Role: Gets the callout defining the view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oCallout[out,: CATBaseUnknown#Release] The callout defining the view.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetPosition

public virtual GetPosition(		`oX`,
		`oY`)

Gets the position.
Role: This method gets the coordinates of the projection of the centre of the 3D bounding box. It is expressed with respect to the sheet coordinate system.

Parameters:

oX: [out] 1st coordinate
oY: [out] 2nd coordinate

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetProjectionPlane

public virtual GetProjectionPlane( oPlane)

Gets the projection plane.
Role: This method gets the projection plane of the view.

Parameters:

oPlane: [out, CATBaseUnknown#Release] The projection plane

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetProjectionProfile

public virtual GetProjectionProfile(		`oProfile`,
		`oVecpro`)

Returns geometric informations about profile for auxiliary view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oProfile: two points defining profile.
oVecPro: The direction of projection of the view

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetSectionProfile

public virtual GetSectionProfile(		`oProfil`,
		`oDepli`,
		`oVecpro`)

Retrieves the section definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oProfil: List of CATMathPoint which contains the profile's points.
oDepli: Defines if the section is offset or aligned. 0: offset, 1: aligned
oVecPro: The direction of projection of the view

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o IsClipped

public virtual IsClipped(

)

Checks if the view is a clipping view.

Returns:
S_OK: if the view is clipped.
S_FALSE: if the view is not clipped.
E_FAIL: if the operation fails.

o IsClippedByBox

public virtual IsClippedByBox(

)

Checks if the view contains a clipping box operator.

Returns:
S_OK: if the view contains a box operator.
S_FALSE: if the view does not contain a box operator.
E_FAIL: if the operation fails.

o Remove3DSpaceClipping

public virtual Remove3DSpaceClipping(

)

Removes the 3D space clipping from the view.

Returns:: S_OK : if the clipping type is correctly remmoved.
E_FAIL : if the operation fails.

o RemoveGVS

public virtual RemoveGVS(

)

RemoveGVS. Removes the association between the GVS and the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Returns:: S_OK : if the GVS is correctly removed from the view.
E_FAIL : if the operation fails.

o Set3DSpaceClipping

public virtual Set3DSpaceClipping( i3DSpaceClippingObject)

Creates or modifies a 3D Space clipping object (modify is 3D space clipping already existing).

Parameters:

i3DSpaceClippingObject: The link to the 3D object defining the Space Clipping.

Returns:

S_OK : if the clipping is correctly created or modified.
E_FAIL : if the operation fails.

o SetAxisSystem

public virtual SetAxisSystem( iAxisSystemLink)

SetAxisSystem. Sets the axis system definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

iAxisSystemLink: [in] The 3D pointed axis system.

Returns:

S_OK : if the view is correctly linked with a 3D axis system.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation fails.

o SetGVSName

public virtual SetGVSName( iViewStyle)

SetGVSName. Sets the GVS name of the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

iViewStyle: The GVS name.

Returns:

S_OK : if the view is correctly associated to the GVS.
E_FAIL : if the operation fails.

o SetPosition

public virtual SetPosition(	const	`iX`,
	const	`iY`)

Sets the position.
Role: This method sets the projection of the centre of the 3D bounding box. It is expressed with respect to the sheet coordinate system.

Parameters:

iX: [in] 1st coordinate
iY: [in] 2nd coordinate

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

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