Drafting2DLUseItf Interface 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 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 GetAngle
| public virtual GetAngle( | | oOrientation) |
-
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 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
- Execution successfully.
- E_FAIL
- Execution failed.
o GetComponents
| public virtual GetComponents( | const | interfaceID, |
| | oElems) |
-
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 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.
- Returns:
- HRESULT
- S_OK
- Execution successfully.
- E_FAIL
- Execution failed.
o GetSheet
| public virtual GetSheet( | | opi2DLSheet) |
-
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 GetViewLink( | | oMother, |
| | oLinkType, |
| | oPosRelation) |
-
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 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 GetVisu2DMode
| public virtual GetVisu2DMode( | | obVisu2DMode) |
-
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 GetVisuBackgroundMode( | | oVisuMode) |
-
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 GetVisuIn3DMode( | | obVisuMode) |
-
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 IsActive( | | oActive) |
-
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 IsFrameVisible( | | oFVisu) |
-
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 LinkWith( | | iMotherView, |
| | iLinkType | = AUTOMATIC, |
| | iPosRelation | = NULL) |
-
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 SetAngle( | | iOrientation) |
-
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 SetAxisData( | | iX, |
| | 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:
-
-
- 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 SetFrameVisibility( | | iFVisu) |
-
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 SetScale( | | iScale) |
-
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 SetViewName( | | 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 SetVisu2DMode
| public virtual SetVisu2DMode( | | ibVisu2DMode) |
-
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 SetVisuBackgroundMode( | | iVisuMode) |
-
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 SetVisuIn3DMode( | | ibVisuMode) |
-
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: CATDrafting2DLUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.