All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface CATIDftViewMakeUp
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftViewMakeUp
Interface used to manage the make-up of the view in the sheet.
Role: The view make-up manages the display layout of a view
in the sheet.
It manages the position, scale, orientation and other display
parameters.
Method Index
- o
GetAngle(double*)
- Gets the view orientation in the sheet.
- o
GetAxisData(double*,double*)
- Returns the coordinates of the makeup coordinate system origin.
- o
GetScaleFactor(double*)
- Enables the user to get the global scale factor between the scale of the view
and the global scaling applied by the sheet to the views.
- o
GetScale(double*)
- Gets the view scale.
- o
GetSheet(CATIDftSheet**)
- Gets the sheet containing this view make-up.
- o
GetViewLink(CATIDftViewMakeUp**,CATDftViewLinkType*,IUnknown**)
- Gets the information concerning the view position rule.
- o
GetView(CATIView**)
- Gets the view associated to this make-up.
- o
IsAxisVisible(boolean*)
- Used to know if the view axis is visible.
- o
IsFrameVisible(boolean*)
- Used to know if the dynamic frame showing the view bounding box is visible.
- o
LinkWith(CATIDftViewMakeUp*,CATDftViewLinkType,IUnknown*)
- Used to link the view in position with an other one.
- o
RemoveViewLink()
- Removes the view link.
- o
SetAngle(double)
- Sets the view orientation in the sheet.
- o
SetAxisData(double,double)
- Sets the coordinates of the makeup coordinate system origin.
- o
SetAxisVisibility(boolean)
- Description : Sets the view axis visibility.
- o
SetFrameVisibility(boolean)
- Description : Sets the view frame visibility.
- o
SetScale(double)
- Sets the view scale.
Methods
o GetAngle
| public virtual GetAngle( | | oOrientation) |
-
Gets the view orientation in the sheet.
- Parameters:
-
- oOrientation
- The view orientation.
o GetAxisData
| public virtual GetAxisData( | | oX, |
| | oY) |
-
Returns the coordinates of the makeup 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 makeup.
- double
- * oY
[out] The y coordinate of the makeup.
Returns:
Un HRESULT
- S_OK
- E_FAIL
o GetScaleFactor
| public virtual GetScaleFactor( | | oScaleFactor) |
-
Enables the user to get the global scale factor between the scale of the view
and the global scaling applied by the sheet to the views.
The relation is viewscale = globalscaling * scalefactor.
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- double
- * oScaleFactor
[out] The scale factor of the view.
- Returns:
- Un HRESULT
- S_OK
- SUCCESS
- E_FAIL
- No attribute available.
o GetScale
| public virtual GetScale( | | oScale) |
-
Gets the view scale.
- Parameters:
-
- oScale
- The view scale.
o GetSheet
| public virtual GetSheet( | | oSheet) |
-
Gets the sheet containing this view make-up.
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- oSheet
- The father sheet.
o GetViewLink
| public virtual GetViewLink( | | oMother, |
| | oLinkType, |
| | oPosRelation) |
-
Gets the information concerning the view position rule.
- Parameters:
-
- CATIDftViewMakeUp
- **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 GetView
| public virtual GetView( | | oView) |
-
Gets the view associated to this make-up.
The view may be a drafting view or a detail.
- Parameters:
-
- oView
- The associated view.
o IsAxisVisible
| public virtual IsAxisVisible( | | oAxisVisu) |
-
Used to know if the view axis is visible.
The axis is visible only when the view is in edition.
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- oAxisVisu
- The axis visibility.
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.
o LinkWith
| public virtual LinkWith( | const | iMotherView, |
| const | iLinkType | = AUTOMATIC, |
| const | iPosRelation | = NULL) |
-
Used to link the view in position with an other one.
- Parameters:
-
- MotherView
- The mother view (concerning positionning).
- iLinkType
- The link mode.
- iPosRelation
- An user defined relation (not used yet).
o RemoveViewLink
| public virtual RemoveViewLink( | ) |
-
Removes the view link.
o SetAngle
| public virtual SetAngle( | const | iOrientation) |
-
Sets the view orientation in the sheet.
- Parameters:
-
- iOrientation
- The view orientation
o SetAxisData
| public virtual SetAxisData( | const | iX, |
| const | iY) |
-
Sets the coordinates of the makeup coordinate system origin.
It is expressed with respect to the sheet coordinate system.
These coordinates, like any length, are measured in millimeters.
- Parameters:
-
- const
- double iX
[in] The x coordinate of the makeup.
- const
- double iY
[in] The y coordinate of the makeup.
Returns:
Un HRESULT
- S_OK
- E_FAIL
o SetAxisVisibility
| public virtual SetAxisVisibility( | const | iAxisVisu) |
-
Description : Sets the view axis visibility.
The axis is visible only when the view is in edition.
Warning: This method is not available with 2D Layout for 3D Design.
- Parameters:
-
- iAxisVisu
- The axis visibility.
o SetFrameVisibility
| public virtual SetFrameVisibility( | const | iFVisu) |
-
Description : Sets the view frame visibility.
- Parameters:
-
- iFVisu
- The frame visibility.
o SetScale
| public virtual SetScale( | const | iScale) |
-
Sets the view scale.
- Parameters:
-
- iScale
- The view scale.
Legal Values: The scale is greater than 0.
This object is included in the file: CATIDftViewMakeUp.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces