All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftSheet
System.IUnknown
|
+---CATIDftSheet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftSheet
Interface of the Sheet object.
Role: The Sheet aggregates view objects
Method Index
- o
AddView(CATIDftView*,double[2])
- Adds a view in the sheet.
- o
AddView(CATIDftViewMakeUp*,boolean)
- Adds a view in the sheet.
- o
GetBackgroundView(CATIDftView**)
- Gets the background view in the sheet.
- o
GetDefaultActiveView(CATIDftView**)
- Gets the view which have to be activated in the sheet.
- o
GetDrawing(CATIDftDrawing**)
- Gets the drawing containing this sheet.
- o
GetGenViewsPosMode(CATDftGenViewsPosMode&)
- Gets the stability mode for the position of generative views inside the sheet.
- o
GetMainView(CATIDftView**)
- Gets the main view in the sheet.
- o
GetProjectionMethod(CATDftProjectionMethod*)
- Gets the projection method in this sheet.
- o
GetScale(double*)
- Gets the global scale associated to the sheet.
- o
GetSheetFrame(int)
-
- o
GetViewMakeUps(CATIUnknownList**)
- Returns the view make-ups referenced by the drawing.
- o
IsDetail(boolean*)
- Used to know if a sheet can be used to as a detail sheet.
- o
ReorderViews(CATLISTV(CATISpecObject_var)&)
- Change the positions of the views in a sheet according to the given
ordered list.
- o
SetAsDetail()
- Sets the sheet as a detail sheet.
- o
SetDefaultActiveView(CATIDftView*)
- Sets the view which have to be activated in the sheet.
- o
SetGenViewsPosMode(CATDftGenViewsPosMode)
- Changes the stability mode for the position of generative views inside the sheet.
- 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
ValidateViewOrder(CATLISTV(CATISpecObject_var)&)
- Validates that the given ordered list can be used as an input
for ReorderViews.
Methods
o AddView
-
Adds a view in the sheet.
- Parameters:
-
- const
- CATIDftView *iView The view to be added.
- const
- double iPosition[2] The view position in the sheet.
o AddView
-
Adds a view in the sheet.
- Parameters:
-
- const
- CATIDftViewMakeUp *iViewMU The view make-up to be added.
- const
- boolean iEmbedView Embed or not the view in the sheet:
TRUE for basic views.
FALSE for Details and twin views.
o GetBackgroundView
-
Gets the background view in the sheet. The background view contains the frame and title-blocks.
- Parameters:
-
- CATIDftView
- **oView The background view in the sheet.
o GetDefaultActiveView
-
Gets the view which have to be activated in the sheet. By default, the active view is the view in edition.
- Parameters:
-
- CATIDftView
- **oView The default active view in the sheet.
o GetDrawing
-
Gets the drawing containing this sheet.
- Parameters:
-
- CATIDftDrawing
- **oDrawing The father drawing.
o GetGenViewsPosMode
-
Gets the stability mode for the position of generative views inside the sheet.
Warning: This method is not available with 2D Layout for 3D Design.
- See also:
- CATIDftSheet.SetGenViewsPosMode
- Parameters:
-
- CATDftGenViewsPosMode
- &oPosMode
[out] the stability mode.
- Returns:
- Un HRESULT
- S_OK
- Success.
- E_FAIL
- Failure.
o GetMainView
-
Gets the main view in the sheet. The main view contains geometry associated to the sheet.
- Parameters:
-
- CATIDftView
- **oView The main view in the sheet.
o GetProjectionMethod
-
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 HRESULT GetScale( | double* | oScale) const = 0 |
-
Gets the global scale associated to the sheet. This scale is applied on the sheet views.
- Parameters:
-
- double
- *oScale The global scale of the sheet
o GetSheetFrame
public virtual HRESULT GetSheetFrame( | int | DisplaySheetFrame) const = 0 |
-
- Deprecated:
- V5R18 Use
CATIDftSheetFormat.GetSheetDisplayMode Gets the sheet frame.
- Parameters:
-
- int
- DisplaySheetFrame = 0 Sheet frame is not displayed.
= 1 Sheet frame is displayed.
o GetViewMakeUps
-
Returns the view make-ups referenced by the drawing.
- Parameters:
-
- CATIUnknownList
- *oLstResult Founded Make-ups are added to the list.
o IsDetail
public virtual HRESULT IsDetail( | boolean* | oDetSheet) const = 0 |
-
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
-
Change the positions of the views in a sheet according to the given
ordered list.
- Parameters:
-
- const
- CATLISTV(CATISpecObject_var) &iOrderedViews
[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 SetAsDetail
public virtual HRESULT SetAsDetail( | )= 0 |
-
Sets the sheet as a detail sheet. All the views in this sheet will be details.
o SetDefaultActiveView
-
Sets the view which have to be activated in the sheet.
By default:
- The view have to be added in the sheet before.
- 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:
-
- const
- CATIDftView *iView The default active view in the sheet.
- See also:
- CATISketchEditor.OpenEdition
o SetGenViewsPosMode
-
Changes the stability mode for the position of generative views inside the sheet.
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- CATDftGenViewsPosMode
- iMode
[in] the stability mode for generative views.
- CATFixedCG
- the image of the center of gravity of the 3D data remains at the same position after an update.
- CATFixedAxis
- the image of the center of gravity of the 3D data moves after an update so that existing and
unmodified geometries remain at the same position.
- Returns:
- a HRESULT
- S_OK
- Success.
- S_FALSE
- Success. Nothing was modified since the mode requested was the current mode.
- E_FAIL
- Failure.
- See also:
- CATDftGenViewsPosMode
o SetPrintArea
public virtual HRESULT SetPrintArea( | const double* | iAreaData)= 0 |
-
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 HRESULT SetPrintAreaActivationState( | const boolean | iActivated)= 0 |
-
Activates or deactivates the print area.
- Parameters:
-
- in
- 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
-
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 HRESULT SetScale( | const double | iScale) = 0 |
-
Sets the global scale associated to the sheet. This scale is applied on the sheet views.
- Parameters:
-
- const
- double iScale The global scale of the sheet
o ValidateViewOrder
-
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:
-
- iOrderedSheets
- 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: CATIDftSheet.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces