All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDftView

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

interface CATIDftView

Interface of the drawing view object.
Role: The view is a workspace containing geometries and annotations. The view may also contain the generative drafting results. The generative drafting specifications are available by using the CATIDftGenerSpec interfaces.

See also:

Method Index

o Activate(): Used to Activate the view.
o AddApplicativeExtension(IID&,IUnknown**): Adds an extension to the view to deal with a specific applicative behavior.
o GetAngle(double*): Gets the view orientation in the sheet.
o GetApplicativeExtension(IID&,IUnknown**): Returns the extension of the view which deals with a specific applicative behavior.
o GetAxisData(double*,double*): Returns the coordinates of the view coordinate system origin.
o GetComponents(IID,CATIUnknownList**): Used to get the view components (annotations, geometry, callout, .
o GetGenerSpec(CATIDftGenerSpec**)
o GetOleSiteList(CATIUnknownList**): Gets the list of OLE sites of the views.
o GetScale(double*): Gets the view scale.
o GetScaleFactor(double*): Enables the user to get the global scale factor between the scale of the view and the global scaling applied by the sheet to the views.
o GetSheet(CATIDftSheet**): Gets the sheet containing the view representation.
o GetViewLink(CATIDftView**,CATDftViewLinkType*,IUnknown**): Gets the information concerning the view position rule.
o GetViewName(wchar_t**): Gets the view name as a string.
o GetViewNameFormula(IUnknown**): Gets the view name formula.
o GetViewType(CATDftViewType*): Gets the view type.
o IsActive(boolean*): Used to know if this view is active.
o IsAxisVisible(boolean*): Used to know if the view axis is visible.
o IsFrameVisible(boolean*): Used to know if the dynamic frame showing the view bounding box is visible.
o LinkWith(CATIDftView*,CATDftViewLinkType,IUnknown*): Used to link the view in position with an other one.
o RemoveViewLink()
o SetAngle(double): Sets the view orientation in the sheet.
o SetAxisData(double,double): Sets the coordinates of the view coordinate system origin.
o SetAxisVisibility(boolean): Description : Sets the view axis visibility.
o SetFrameVisibility(boolean): Description : Sets the view frame visibility.
o SetScale(double): Sets the view scale.
o SetViewName(wchar_t*): Sets the view name as a string.
o SetViewType(CATDftViewType&): Sets the view type.

Methods

o Activate

public virtual Activate(

)

Used to Activate the view. The active view is the view in edition. There is only one active view per sheet in a Drawing.

Returns:

HRESULT

S_OK: View is activated.
E_FAIL: View isn't activated.

o AddApplicativeExtension

public virtual AddApplicativeExtension(	const	`interfaceID`,
		`iExtension`)

Adds an extension to the view to deal with a specific applicative behavior.

Parameters:

interfaceID: The interface which describe the extension to be added
oExtension: The added extension. If the extension already exists, it is returned also

Returns:

HRESULT

S_OK: Execution successfully.
E_UNEXPECTED: f internal problem.
E_INVALIDARG: if not recognize interfaceID.
E_FAIL: Execution failed.

o GetAngle

public virtual GetAngle( oOrientation)

Gets the view orientation in the sheet.

Parameters:

oOrientation: The view orientation.

o GetApplicativeExtension

public virtual GetApplicativeExtension(	const	`interfaceID`,
		`oExtension`)

Returns the extension of the view which deals with a specific applicative behavior.

Parameters:

interfaceID: The interface which describes the extension.
oExtension: [out, CATBaseUnknown#Release] The result of the query

Returns:

HRESULT

S_OK: Execution successfully.
E_UNEXPECTED: f internal problem.
E_INVALIDARG: if not recognize interfaceID.
E_FAIL: Execution failed.

o GetAxisData

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

Returns the coordinates of the view coordinate system origin. It is expressed with respect to the sheet coordinate system. These coordinates, like any length, are measured in millimeters.

Parameters:

double: * oX [out] The x coordinate of the view.
double: * oY [out] The y coordinate of the view.

Returns:

Un HRESULT

S_OK
E_FAIL

o GetComponents

public virtual GetComponents(	const	`interfaceID`,
		`oElems`)

Used to get the view components (annotations, geometry, callout, ...). All geometries and annotations are retrieved if IID_CATBaseUnknown is specified. Pictures are retrieved only if IID_CATIDrwPicture is specified. Callouts are retrieved only if IID_CATIDrwCalloutAccess is specified. 2D Component instances (aka Ditto) are not managed by this API.

Parameters:

IID: The interface filter.
oElems: [out, CATBaseUnknown#Release] List of elements found.

Returns:

HRESULT

S_OK: Elements found
E_FAIL: Execution failed.

o GetGenerSpec

public virtual GetGenerSpec( opiDftGenerSpec)

Deprecated:: R216 For generative or 2DL views, use instead. For TPS views, use and #GetApplicativeExtension instead.

o GetOleSiteList

public virtual GetOleSiteList( oOleElemsList)

Gets the list of OLE sites of the views.

Returns:

oOleElemsList [out, CATBaseUnknown#Release] The list of OleSite features

Returns:

HRESULT

S_OK: Elements found
E_FAIL: Execution failed.

o GetScale

public virtual GetScale( oScale)

Gets the view scale.

Parameters:

oScale: The view scale.

o GetScaleFactor

public virtual GetScaleFactor( oScaleFactor)

Enables the user to get the global scale factor between the scale of the view and the global scaling applied by the sheet to the views. The relation is viewscale = globalscaling * scalefactor.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

double: * oScaleFactor [out] The scale factor of the view.

Returns:

Un HRESULT

S_OK: SUCCESS
E_FAIL: No attribute available.

o GetSheet

public virtual GetSheet( opiDftSheet)

Gets the sheet containing the view representation. The returned sheet is the sheet containing the view make-up of the view.

Parameters:

opiDftSheet: [out, CATBaseUnknown#Release] The sheet containing the view.

Returns:

HRESULT

S_OK: The Sheet has been found
E_FAIL: Execution failed.

o GetViewLink

public virtual GetViewLink(		`oMother`,
		`oLinkType`,
		`oPosRelation`)

Gets the information concerning the view position rule.

Parameters:

CATIDftView: **oMother [out] The mother view (concerning positionning)
CATDftViewLinkType: *oLinkType [out] The link mode
IUnknown: **oPosRelation [out] The Poitioning relation

Returns:

Un HRESULT

S_OK: if oMother is valuated
E_FAIL

o GetViewName

public virtual GetViewName( oName)

Gets the view name as a string.

Parameters:

oName: The view name

Returns:

HRESULT

S_OK: View name has been found
E_FAIL: No view name found.

o GetViewNameFormula

public virtual GetViewNameFormula( oVNameFormula)

Gets the view name formula. This object is a CKE formula computing the view name. from different inputs.

Parameters:

oVNameFormula: [out, CATBaseUnknown#Release] The view name formula

Returns:

HRESULT

S_OK: View name formula has been modified
E_FAIL: No view name formula found.

o GetViewType

public virtual GetViewType( oType)

Gets the view type.

Parameters:

oType: The view type

Returns:

HRESULT

S_OK: View type has been found
E_FAIL: No view type found.

o IsActive

public virtual IsActive( oActive)

Used to know if this view is active. The active view is the view in edition. There is only one active view int the drawing.

Parameters:

oActive: TRUE if the view is active.

Returns:

HRESULT

S_OK: Execution successfully.
E_FAIL: Execution failed.

o IsAxisVisible

public virtual IsAxisVisible( oAxisVisu)

Used to know if the view axis is visible. The axis is visible only when the view is in edition.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oAxisVisu: The axis visibility.

o IsFrameVisible

public virtual IsFrameVisible( oFVisu)

Used to know if the dynamic frame showing the view bounding box is visible.

Parameters:

oFVisu: The frame visibility.

o LinkWith

public virtual LinkWith(	const	`iMotherView`,
	const	`iLinkType`	`= AUTOMATIC`,
	const	`iPosRelation`	`= NULL`)

Used to link the view in position with an other one.

Parameters:

MotherView: The mother view (concerning positionning).
iLinkType: The link mode.
iPosRelation: An user defined relation (not used yet).

o RemoveViewLink

public virtual RemoveViewLink(

)

Deprecated:: R417 Removes the view link.

o SetAngle

public virtual SetAngle( const iOrientation)

Sets the view orientation in the sheet.

Parameters:

iOrientation: The view orientation

o SetAxisData

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

Sets the coordinates of the view coordinate system origin. It is expressed with respect to the sheet coordinate system. These coordinates, like any length, are measured in millimeters.

Parameters:

const: double iX [in] The x coordinate of the view.
const: double iY [in] The y coordinate of the view.

Returns:

Un HRESULT

S_OK
E_FAIL

o SetAxisVisibility

public virtual SetAxisVisibility( const iAxisVisu)

Description : Sets the view axis visibility. The axis is visible only when the view is in edition.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

iAxisVisu: The axis visibility.

o SetFrameVisibility

public virtual SetFrameVisibility( const iFVisu)

Description : Sets the view frame visibility.

Parameters:

iFVisu: The frame visibility.

o SetScale

public virtual SetScale( const iScale)

Sets the view scale.

Parameters:

iScale: The view scale.
Legal Values: The scale is greater than 0.

o SetViewName

public virtual SetViewName( const iName)

Sets the view name as a string. This name can override an existing formula.

Parameters:

iName: The view name

Returns:

HRESULT

S_OK: View name has been modified
E_FAIL: No modification applied.

o SetViewType

public virtual SetViewType( const iType)

Sets the view type.

Parameters:

iType: The view type

Returns:

HRESULT

S_OK: View type has been modified
E_FAIL: Execution failed.

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