All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Drafting2DLInterfaces Interface CATI2DLayoutView

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATI2DLayoutView
 

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


interface CATI2DLayoutView

this interface manages the 2D Layout View.


Method Index


o Activate()
Used to Activate the view.
o GetAngle(double*)
Gets the view orientation in the sheet.
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 GetOleSiteList(CATIUnknownList**)
Gets the list of OLE sites of the views.
o GetScale(double*)
Gets the view scale.
o GetSheet(CATI2DLayoutSheet**)
Gets the 2DL sheet containing the view representation.
o GetViewLink(CATI2DLayoutView**,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 GetVisu2DMode(CATBoolean&)
Gets the 2D mode for background visualization of the view.
o GetVisuBackgroundMode(CatVisuBackgroundMode&)
Gets the 2D-3D background visu mode of the view ie in the 3D windows and in the background of each view in every 2D context.
o GetVisuIn3DMode(CATBoolean&)
Gets the 3D visualization mode of the layout in the 3D Viewer.
o IsActive(boolean*)
Used to know if this view is active.
o IsFrameVisible(boolean*)
Used to know if the dynamic frame showing the view bounding box is visible.
o LinkWith(CATI2DLayoutView*,CATDftViewLinkType,IUnknown*)
Used to link the view in position with an other one.
o SetAngle(double)
Sets the view orientation in the sheet.
o SetAxisData(double,double)
Sets the coordinates of the view coordinate system origin.
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 SetVisu2DMode(CATBoolean)
Sets the 2D mode for background visualization of the view.
o SetVisuBackgroundMode(CatVisuBackgroundMode)
Sets the 2D-3D background visu mode of the view.
o SetVisuIn3DMode(CATBoolean)
Sets the 3D visualization mode of the layout in the 3D Viewer.

Methods


o Activate
public virtual HRESULT Activate()= 0
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 GetAngle
public virtual HRESULT GetAngle(double* oOrientation) = 0
Gets the view orientation in the sheet.
Parameters:
oOrientation
The view orientation.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o GetAxisData
public virtual HRESULT GetAxisData(double* oX,
double* oY)= 0
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
Execution successfully.
E_FAIL
Execution failed.
o GetComponents
public virtual HRESULT GetComponents( const IID interfaceID,
CATIUnknownList** oElems) = 0
Used to get the view components (annotations, geometry, callout, ...).
Parameters:
IID
The interface filter.
oElems
[out, CATBaseUnknown#Release] List of elements found.
Returns:
HRESULT
S_OK
Elements found
E_FAIL
Execution failed.
o GetOleSiteList
public virtual HRESULT GetOleSiteList(CATIUnknownList** oOleElemsList) = 0
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 HRESULT GetScale(double* oScale)= 0
Gets the view scale.
Parameters:
oScale
The view scale.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o GetSheet
public virtual HRESULT GetSheet(CATI2DLayoutSheet** opi2DLSheet) = 0
Gets the 2DL sheet containing the view representation.
Parameters:
CATI2DLayoutSheet
**opi2DLSheet [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 HRESULT GetViewLink(CATI2DLayoutView** oMother,
CATDftViewLinkType* oLinkType,
IUnknown** oPosRelation) = 0
Gets the information concerning the view position rule.
Parameters:
CATI2DLayoutView
**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 HRESULT GetViewName(wchar_t** oName) = 0
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 HRESULT GetViewNameFormula(IUnknown** oVNameFormula)= 0
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 HRESULT GetViewType(CATDftViewType* oType) = 0
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 GetVisu2DMode
public virtual HRESULT GetVisu2DMode(CATBoolean& obVisu2DMode) = 0
Gets the 2D mode for background visualization of the view.
Parameters:
obVisuMode:
The 2D Visu mode: TRUE if the 2D is displayed
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o GetVisuBackgroundMode
public virtual HRESULT GetVisuBackgroundMode(CatVisuBackgroundMode& oVisuMode) =0
Gets the 2D-3D background visu mode of the view ie in the 3D windows and in the background of each view in every 2D context.
Parameters:
iVisuMode:
The background Visu mode: TRUE if the background is displayed
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o GetVisuIn3DMode
public virtual HRESULT GetVisuIn3DMode(CATBoolean& obVisuMode) =0
Gets the 3D visualization mode of the layout in the 3D Viewer.
Parameters:
obVisuMode:
The 3D Visu mode: TRUE if the 3D is displayed
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o IsActive
public virtual HRESULT IsActive(boolean* oActive) = 0
Used to know if this view is active. The active view is the view in edition. There is only one active view in the 2DL.
Parameters:
oActive
TRUE if the view is active.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o IsFrameVisible
public virtual HRESULT IsFrameVisible(boolean* oFVisu) = 0
Used to know if the dynamic frame showing the view bounding box is visible.
Parameters:
oFVisu
The frame visibility. TRUE if the frame is vcisible.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o LinkWith
public virtual HRESULT LinkWith(CATI2DLayoutView* iMotherView,
CATDftViewLinkType iLinkType= AUTOMATIC,
IUnknown* iPosRelation= NULL) = 0
Used to link the view in position with an other one.
Parameters:
MotherView
The mother view (concerning positioning).
iLinkType
The link mode.
iPosRelation
An user defined relation (not used yet).
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetAngle
public virtual HRESULT SetAngle(double iOrientation) = 0
Sets the view orientation in the sheet.
Parameters:
iOrientation
The view orientation
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetAxisData
public virtual HRESULT SetAxisData(double iX,
double iY)= 0
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:
double iX [in] The x coordinate of the view.
double iY [in] The y coordinate of the view.
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetFrameVisibility
public virtual HRESULT SetFrameVisibility(boolean iFVisu) = 0
Description : Sets the view frame visibility.
Parameters:
iFVisu
The frame visibility. TRUE if the view is active.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetScale
public virtual HRESULT SetScale(double iScale) = 0
Sets the view scale.
Parameters:
iScale
The view scale.
Legal Values: The scale is greater than 0.
Returns:
HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetViewName
public virtual HRESULT SetViewName(wchar_t* iName) = 0
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 SetVisu2DMode
public virtual HRESULT SetVisu2DMode(CATBoolean ibVisu2DMode) =0
Sets the 2D mode for background visualization of the view.
Parameters:
ibVisuMode:
The 2D Visu mode: TRUE to display the 2D
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetVisuBackgroundMode
public virtual HRESULT SetVisuBackgroundMode(CatVisuBackgroundMode iVisuMode) =0
Sets the 2D-3D background visu mode of the view. ie in the 3D windows and in the background of each view in every 2D context
Parameters:
obVisuMode:
The background Visu mode: TRUE to display the background
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.
o SetVisuIn3DMode
public virtual HRESULT SetVisuIn3DMode(CATBoolean ibVisuMode) =0
Sets the 3D visualization mode of the layout in the 3D Viewer.
Parameters:
ibVisuMode:
The 3D Visu mode: TRUE to display the 3D
Returns:
Un HRESULT
S_OK
Execution successfully.
E_FAIL
Execution failed.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.