Drafting2DLUseItf Interface CATI2DLayoutSheet

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

interface CATI2DLayoutSheet

This interface manages the 2DL Sheet.

Method Index


o CreateAuxiliaryView2DL(CATI2DLayoutView*,double[4],CATBoolean,CATDftViewType,double[2],CATUnicodeString&,CATI2DLayoutView**)
Creates an auxiliary or a section View2DL from a given View2DL.
o CreatePrimaryView2DL(double[2],CATUnicodeString&,CATI2DLayoutView**)
Creates a primary View2DL.
o CreateRelatedView2DL(CATI2DLayoutView*,double[2],CAT2DLViewSide,CATUnicodeString&,CATI2DLayoutView**)
Creates a projection or isometric View2DL from a given View2DL.
o CreateView2DLFrom3DPlane(double[3],double[3],double[3],CATDftViewType,double*,CATUnicodeString&,CATI2DLayoutView**)
Creates a viewFrom3D View2DL with the given 3Dplane
o CreateView2DLFromFTA(CATBaseUnknown*,double[2],CATI2DLayoutView**)
Creates a 2DL view from FTA Capture or View.
o GetBackgroundView(CATI2DLayoutView**)
Gets the background view in the sheet.
o GetDefaultActiveView(CATI2DLayoutView**)
Gets the view which have to be activated in the sheet.
o GetLayout(CATI2DLayoutLayout**)
Gets the layout root containing this sheet.
o GetProjectionMethod(CATDftProjectionMethod*)
Gets the projection method in this sheet.
o GetScale(double*)
o GetViews(CATIUnknownList**)
Returns the view referenced by the sheet.
o GetVisuIn3DMode(CATBoolean&)
Gets the 3D visualization mode of the layout in the 3D Viewer
o IsCurrent(CATBoolean*)
This method is used to know if the sheet is the current one in the Layout.
o IsDetail(boolean*)
Used to know if a sheet can be used to as a detail sheet.
o ReorderViews(CATIUnknownList*)
Change the positions of the views in a sheet according to the given ordered list.
o SetDefaultActiveView(CATI2DLayoutView*)
The active view is the view in edition.
o SetPrintArea(double*)
Sets a set of coordinates to define a rectangle print area.
o SetPrintAreaActivationState(boolean)
Activates or deactivates the print area.
o SetProjectionMethod(CATDftProjectionMethod)
Sets the projection method in this sheet.
o SetScale(double)
Sets the global scale associated to the sheet.
o SetVisuIn3DMode(CATBoolean)
Sets the 3D visualization mode of the layout in the 3D Viewer
o ValidateViewOrder(CATIUnknownList*)
Validates that the given ordered list can be used as an input for ReorderViews.

Methods


o CreateAuxiliaryView2DL
public virtual CreateAuxiliaryView2DL( iReferenceView,
iProfile,
ibOrient,
iViewType,
const iCoord,
iViewName,
opi2DLView)
Creates an auxiliary or a section View2DL from a given View2DL.
Parameters:
CATI2DLayoutView
*iReferenceView [in] The reference view. Must be a projection View.
double[4]
iProfile [in] The callout's segment gives the trace of the auxiliary View2DL's projection plane in the reference View2DL.
CATBoolean
ibOrient [in] ibOrient = FALSE: the View2DL will be drawn as seen from the right of the segment in the reference view. ibOrient = TRUE: the View2DL will be drawn as seen from the left of the segment in the reference view.
CATDftViewType
iViewType The admissible types are DftSectionView, DftSectionCutView and DftAuxiliaryView.
const
double iCoord[2] [in] The coordinate in the Sheet2DL for the new View2DL.
iViewName
[in] Name of the view. (If iViewName is empty, the view name will calculated automaticaly).
CATI2DLayoutView
*&opi2DLView [out, IUnknown#Release] The interface on the View2DL whose iid is iInterface PRECONDITION1: the reference View2DL must be a projection view. PRECONDITION2: the callout segment's length must not be 0.
Returns:
HRESULT S_OK = Success. E_FAIL = Error: Internal error or a precondition was not satisfied.
o CreatePrimaryView2DL
public virtual CreatePrimaryView2DL( const iCoord,
iViewName,
opi2DLView)
Creates a primary View2DL. The caracteristics (ex: type, the view plane etc) of this new view are computed based on the caracteristics stored in the current embedded standard.
Parameters:
const
double iCoord[2] [in] The coordinates in the Sheet2DL for the new View2DL.
iViewName
[in] Name of the view. (If iViewName is empty, the view name will calculated automaticaly).
CATI2DLayoutView
**o2DLView [out, IUnknown#Release] The interface on the View2DL.
Returns:
a HRESULT
S_OK
Success.
E_FAIL
Error. Internal error or a precondition was not satisfied.
o CreateRelatedView2DL
public virtual CreateRelatedView2DL( iReferenceView,
const iCoord,
iSide,
iViewName,
opi2DLView)
Creates a projection or isometric View2DL from a given View2DL. The view will be created in the same Sheet2DL as the given View2DL, at the given position.
Parameters:
CATI2DLayoutView
*iReferenceView [in] The reference View2DL from which the new View2DL is created.
const
double iCoord[2] [in] The coordinates in the Sheet2DL of the new View2DL.
CAT2DLViewSide
iSide [in] Used with the ViewBox and iReferenceView to give the related view to create (type etc).
See also:
iViewName
[in] Name of the view. (If iViewName is empty, the view name will calculated automaticaly).
CATI2DLayoutView
**opi2DLView [out, IUnknown#Release] The interface on the View2DL.
Returns:
PRECONDITION1: the reference View2DL must be a projection view. PRECONDITION3: a view with the same type must not already exist in the set of View2DLs the reference View2DL belongs to. HRESULT: S_OK: Success. S_FALSE: The requested view already exists in the set of views to which iReferenceView belongs. No view is created. E_FAIL: Error. Internal error or a precondition was not satisfied.
o CreateView2DLFrom3DPlane
public virtual CreateView2DLFrom3DPlane( const iOrigin,
const iFirstDirection,
const iSecondDirection,
iViewType,
const iCoord,
iViewName,
opi2DLView)
Creates a viewFrom3D View2DL with the given 3Dplane
Parameters:
const
double iOrigin[3] [in] The view's view plane origin in 3D space.
const
double iFirstDirection[3] [in] A direction which the view's viewplane H axis has to be colinear with
const
double iSecondDirection[3] [in] A direction which the view's viewplane V axis has to be colinear with
iViewType
The view type: Auxiliary or SectionCut or SectionView
const
double *iCoord [in] The coordinate in the aggregating Sheet for the new View2DL.
const IID iInterface [in] The IID of the interface by which the newly created View2DL will be retrieved.
IUnknown *&oView [out] The interface on the View2DL whose iid is iInterface PRECONDITION1: iViewType must be either auxiliary or section or section cut. PRECONDITION2: iFirstDirection and iSecondDirection must be orthogonal.
Returns:
HRESULT S_OK = Success. E_FAIL = Error. Internal error or a precondition was not satisfied.
o CreateView2DLFromFTA
public virtual CreateView2DLFromFTA( iFTAComponent,
const iCoord,
opi2DLView)
Creates a 2DL view from FTA Capture or View.
Parameters:
CATBasUnknown
*iFTAComponent [in] The FTA Component: A FTA Capture or View.
const
double iCoord[2] [in] The coordinate in the Sheet2DL for the new View2DL.
CATI2DLayoutView
*&opi2DLView [out, IUnknown#Release] The interface on the View2DL whose iid is iInterface PRECONDITION2: FTA Component and Sheet must be in the same document.
Returns:
HRESULT S_OK = Success. E_FAIL = Error: Internal error or a precondition was not satisfied.
o GetBackgroundView
public virtual GetBackgroundView( opi2DLView)
Gets the background view in the sheet. The background view contains the frame and title-blocks.
Parameters:
CATI2DLayoutView
**oView [out, CATBaseUnknown#Release] The background view in the sheet.
o GetDefaultActiveView
public virtual GetDefaultActiveView( opi2DLView)
Gets the view which have to be activated in the sheet. By default, the active view is the view in edition.
Parameters:
CATI2DLayoutView
**opi2DLView [out, CATBaseUnknown#Release] The default active view in the sheet.
o GetLayout
public virtual GetLayout( opi2DLayout)
Gets the layout root containing this sheet.
Parameters:
CATI2DLayoutLayout
**opi2DLayout [out, CATBaseUnknown#Release] The 2DLayout root.
o GetProjectionMethod
public virtual GetProjectionMethod( oProjMethod)
Gets the projection method in this sheet.
Parameters:
CATDftProjectionMethod
*oProjMethod The projection method: - CATFirstAngle: First angle standard. - CATThirdAngle: Third angle standard.
o GetScale
public virtual GetScale( oScale)
o GetViews
public virtual GetViews( oLstResult)
Returns the view referenced by the sheet.
Parameters:
CATIUnknownList
*oLstResult [out, CATBaseUnknown#Release] Founded views are added to the list.
o GetVisuIn3DMode
public virtual GetVisuIn3DMode( obVisuMode)
Gets the 3D visualization mode of the layout in the 3D Viewer
Parameters:
obVisuMode:
o IsCurrent
public virtual IsCurrent( oSheetStatus)
This method is used to know if the sheet is the current one in the Layout. The current sheet is the sheet containing the view in edition.
Returns:
The status
Legal values:
0
The sheet is not the current one
1
The sheet is the current one
o IsDetail
public virtual IsDetail( oDetSheet)
Used to know if a sheet can be used to as a detail sheet.
Parameters:
boolean
*oDetSheet TRUE if it is a detail sheet
o ReorderViews
public virtual ReorderViews( ipListOrderedViews)
Change the positions of the views in a sheet according to the given ordered list.
Parameters:
CATIUnknownList
*ipListOrderedViews [in] The ordered list of the views in the sheet. Preconditions:
ValidateViewOrder(iOrderedViews) must succeed. @see ValidateViewOrder.
Returns:
A HRESULT
S_OK
Views were reordered.
E_UNEXPECTED
Preconditions not met.
E_FAIL
Internal error.
o SetDefaultActiveView
public virtual SetDefaultActiveView( ipi2DLView)
The active view is the view in edition.
Note: Do not use this service to activate the background view in UI context, because the command will be canceled by the background workshop activation. Only, in this particular case, it is recommended to edit the sketch by using Openedition and CloseEdition methods defined in CATISketchEditor interface implemented by the view. These methods allow to manage geometry creation or modification in a view when it is not the active view of a drawing.
Parameters:
CATI2DLayoutView
*ipi2DLView [out, CATBaseUnknown#Release] The default active view in the sheet.
o SetPrintArea
public virtual SetPrintArea( const iAreaData)
Sets a set of coordinates to define a rectangle print area.
Parameters:
const
double * iAreaData [in] A four double table describing the parameters of the area box:
iAreaData[0] as the low x coordinate of the area.
iAreaData[1] as the low y coordinate of the area.
iAreaData[2] as the width of the area. The value must be strictly positive.
iAreaData[3] as the heigth of the area. The value must be strictly positive.
All the values in the table are given in mm.
Returns:
Un HRESULT
S_OK
The print area was successfully defined.
E_INVALIDARG
The input arguments do not match with specified.
E_FAIL
No print area could be defined.
o SetPrintAreaActivationState
public virtual SetPrintAreaActivationState( const iActivated)
Activates or deactivates the print area.
Parameters:
in
const boolean iActivated [in] The activation state of the print area (TRUE means activated, FALSE means deactivated).
Returns:
Un HRESULT
S_OK
The activation state could be valuated.
E_FAIL
No activation or deactivation possible.
o SetProjectionMethod
public virtual SetProjectionMethod( const oProjMethod)
Sets the projection method in this sheet.
Parameters:
const
CATDftProjectionMethod oProjMethod The projection method: - CATFirstAngle: First angle standard. - CATThirdAngle: Third angle standard.
o SetScale
public virtual SetScale( iScale)
Sets the global scale associated to the sheet. This scale is applied on the sheet views.
Parameters:
double
iScale The global scale of the sheet
o SetVisuIn3DMode
public virtual SetVisuIn3DMode( ibVisuMode)
Sets the 3D visualization mode of the layout in the 3D Viewer
Parameters:
ibVisuMode:
o ValidateViewOrder
public virtual ValidateViewOrder( ipListOrderedViews)
Validates that the given ordered list can be used as an input for ReorderViews. i.e. validates that: iOrderedViews is the result of a permutation applied to the list of all the views of this sheet with the following constraint: iOrderedViews[1] and iOrderedViews[2] must be respectively the sheet's mainview and background view.
Parameters:
CATIUnknownList
*ipListOrderedViews The list of views to validate.
Returns:
An HRESULT value.
Legal values:
S_OK
iOrderedViews is a valid input.
E_XXX
iOrderedViews is not a valid input.
This object is included in the file: CATI2DLayoutSheet.h
If needed, your Imakefile.mk should include the module: CATDrafting2DLUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.