All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATISheet
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISheet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISheet
Interface of the drawing sheet object.
Role: The sheets represents the paper sheets used in manual
drawing works.
The main role of the sheets is to manage formats and display views.
An empty sheet contains 2 views :
The background view which is used for frames and title blocks
The main view which contains the geometry directly created in the sheet.
Method Index
- o
AddView(CATIDftViewMakeUp*,boolean)
- This method is used to add a view in the sheet
Use the CATIDrwFactory interface to create the view and view make-up.
- o
AddView(CATIView_var,double[2])
- This method is used to add a view in the sheet.
- o
GetBackgroundView()
- Gets the background view.
- o
GetCurrentView()
- Gets the current view.
- o
GetCurrentViewMakeUp(CATIDftViewMakeUp**)
- Gets the make up of the current view.
- o
GetDrawing()
- Gets the drawing containing this sheet.
- o
GetFramePoints(double&,double&,double&,double&)
- Gets the coordinates of the sheet frame.
- o
GetMainView()
- Gets the main view.
- o
GetProjectionMethod()
- Gets the projection method for the sheet.
- o
GetScale()
- Gets the global scale associated to the sheet.
- o
GetViewList()
- Returns the views referenced by the sheet.
- o
IsCurrent()
- This method is used to know if the sheet is the current one in the drawing.
- o
IsUpdated()
- This method is used to know if the sheet is up to date.
- o
ReorderViews(CATLISTV(CATISpecObject_var)&)
- Change the positions of the views in a sheet according to the given
ordered list.
- o
SetCurrentView(CATIDftViewMakeUp*)
- Sets a view as the current view.
- o
SetCurrentView(CATIView_var)
- Sets a view as the current view.
- o
SetProjectionMethod(CatSheetProjectionMethod)
- Sets the projection method for the 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
-
This method is used to add a view in the sheet
Use the CATIDrwFactory interface to create the view and view make-up.
- See also:
- CATIDrwFactory
- Parameters:
-
- iViewMU
- The view make-up to be added
- iEmbedView
- Not used yet.
o AddView
public virtual void AddView( | CATIView_var | iView, |
| double[2] | iPosition) = 0 |
-
This method is used to add a view in the sheet.
Use the CATIDrwFactory interface to create the view
- See also:
- CATIDrwFactory
- Parameters:
-
- iView
- The view to be added
- iPosition[2]
- The view position in the sheet
o GetBackgroundView
-
Gets the background view.
The background view is the view in the background of the sheet.
This view contains in general the frames and title blocks.
There is a background view per sheet.
- Returns:
- The background view.
o GetCurrentView
-
Gets the current view.
The current view is the view in edition when the sheet is current.
- Returns:
- The current view.
o GetCurrentViewMakeUp
-
Gets the make up of the current view.
The current view is the view in edition when the sheet is current.
- Returns:
- The current view make up.
o GetDrawing
-
Gets the drawing containing this sheet.
- Returns:
- The drawing containing this sheet.
o GetFramePoints
public virtual int GetFramePoints( | double& | oBLx, |
| double& | oBLy, |
| double& | oTRx, |
| double& | oTRy)= 0 |
-
Gets the coordinates of the sheet frame.
The sheet frame is the graphical representation of the sheet format (A0, A1, ...)..
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- oBLx
- The bottom left x coordinate
- oBLy
- The bottom left y coordinate
- oTRx
- The top right x coordinate
- oTRy
- The top right y coordinate
o GetMainView
-
Gets the main view.
The main view is the view suporting geometries and annotations for a sheet.
In other words, the main view is the default view of a sheet.
There is a main view per sheet.
- Returns:
- The main view.
o GetProjectionMethod
public virtual CatSheetProjectionMethod GetProjectionMethod( | )= 0 |
-
Gets the projection method for the sheet.
The projection method may be first or third angle.
- Returns:
- The projection method.
Legal values: Possible values are catFirstAngle or catThirdAngle
o GetScale
public virtual double GetScale( | )= 0 |
-
Gets the global scale associated to the sheet.
This scale is applied on the sheet views.
- Returns:
- The global sheet scale.
Legal values:
- The scale is greater than 0.
o GetViewList
-
Returns the views referenced by the sheet.
The list includes the background and main views.
- Returns:
- The view list.
o IsCurrent
public virtual int IsCurrent( | )= 0 |
-
This method is used to know if the sheet is the current one in the drawing.
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 IsUpdated
public virtual int IsUpdated( | )= 0 |
-
This method is used to know if the sheet is up to date.
Warning: This method is not available with 2D Layout for 3D Design.
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 this 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 SetCurrentView
-
Sets a view as the current view.
This view become in edition when the sheet is current.
Precondition: The view have to be added to the sheet before calling this method.
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:
-
- iViewMU
- The view make up pointing the view.
o SetCurrentView
-
Sets a view as the current view.
This view become in edition when the sheet is current.
Precondition: The view have to be added to the sheet before calling this method.
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:
-
- iView
- The view to be current.
o SetProjectionMethod
public virtual void SetProjectionMethod( | CatSheetProjectionMethod | iProjMethod) = 0 |
-
Sets the projection method for the sheet.
The projection method may be first or third angle.
- Parameters:
-
- iProjMethod
- The projection method
Legal values: Possible values are catFirstAngle or catThirdAngle
o SetScale
public virtual void SetScale( | const double& | iScale) = 0 |
-
Sets the global scale associated to the sheet.
- Parameters:
-
- iScale
- The sheet global scale.
Legal Values: The scale is greater than 0.
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: CATISheet.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces