All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftViewMakeUp

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetScale(double*)
Gets the view scale.
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 GetSheet(CATIDftSheet**)
Gets the sheet containing this view make-up.
o GetView(CATIView**)
Gets the view associated to this make-up.
o GetViewLink(CATIDftViewMakeUp**,CATDftViewLinkType*,IUnknown**)
Gets the information concerning the view position rule.
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 HRESULT GetAngle(double* oOrientation) const = 0
Gets the view orientation in the sheet.
Parameters:
oOrientation
The view orientation.
o GetAxisData
public virtual HRESULT GetAxisData(double* oX,
double* oY)= 0
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 GetScale
public virtual HRESULT GetScale(double* oScale) const = 0
Gets the view scale.
Parameters:
oScale
The view scale.
o GetScaleFactor
public virtual HRESULT GetScaleFactor(double* oScaleFactor)const = 0
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 GetSheet
public virtual HRESULT GetSheet(CATIDftSheet** oSheet) const = 0
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 GetView
public virtual HRESULT GetView(CATIView** oView) const = 0
Gets the view associated to this make-up. The view may be a drafting view or a detail.
Parameters:
oView
The associated view.
o GetViewLink
public virtual HRESULT GetViewLink(CATIDftViewMakeUp** oMother,
CATDftViewLinkType* oLinkType,
IUnknown** oPosRelation) const = 0
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 IsAxisVisible
public virtual HRESULT IsAxisVisible(boolean* oAxisVisu) const = 0
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 HRESULT IsFrameVisible(boolean* oFVisu) const = 0
Used to know if the dynamic frame showing the view bounding box is visible.
Parameters:
oFVisu
The frame visibility.
o LinkWith
public virtual HRESULT LinkWith( const CATIDftViewMakeUp* iMotherView,
const CATDftViewLinkType iLinkType= AUTOMATIC,
const IUnknown* iPosRelation= NULL) = 0
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 HRESULT RemoveViewLink()= 0
Removes the view link.
o SetAngle
public virtual HRESULT SetAngle( const double iOrientation) = 0
Sets the view orientation in the sheet.
Parameters:
iOrientation
The view orientation
o SetAxisData
public virtual HRESULT SetAxisData( const double iX,
const double iY)= 0
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 HRESULT SetAxisVisibility( const boolean iAxisVisu) = 0
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 HRESULT SetFrameVisibility( const boolean iFVisu) = 0
Description : Sets the view frame visibility.
Parameters:
iFVisu
The frame visibility.
o SetScale
public virtual HRESULT SetScale( const double iScale) = 0
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

Copyright © 2003, Dassault Systèmes. All rights reserved.