DraftingUseItf Interface CATIDftFramingDefinition
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftFramingDefinition
Interface used to manage framing of the views.
Role: The framing is used to clip visually a view with polygones.
Method Index
- o
GetFramePoints(int,double*)
- Access to the frame points definition.
- o
GetFramingInformations(boolean*,int*,boolean*)
- Get the informations related to the frame : availability and number of definition points.
- o
SetFramePoints(double*,int)
- Set the points of the polygone 's frame definition.
- o
SetFramingAvailability(boolean)
- Set the availability of the frame.
- o
SetFramingProfileStatus(boolean)
- Set the visibility of the framing profile.
Methods
o GetFramePoints
| public virtual GetFramePoints( | const | inbPoints, |
| | oPoints) |
-
Access to the frame points definition.
- Parameters:
-
- const
- int inbPoints
[in] number of points
- double
- * oPoints
[out] coordinates of points
Returns:
Un HRESULT
- S_OK
- operation successfull
- E_FAIL
- no frame available or unexpected error
o GetFramingInformations
| public virtual GetFramingInformations( | | oIsAvailable, |
| | oNbPoints, |
| | oProfileStatus) |
-
Get the informations related to the frame : availability and number of definition points.
- Parameters:
-
- boolean*
- oIsAvailable
[out] TRUE : frame is available , FALSE : no frame available
- int*
- oNbPoints
[out] number of definition points
- boolean*
- oProfileStatus
[out] TRUE : framing profile is visible , FALSE : profile is hidden
Returns:
Un HRESULT
- S_OK
- operation successfull
- E_FAIL
- no frame available or unexpected error
o SetFramePoints
| public virtual SetFramePoints( | const | iCoordinates, |
| | inbPoints) |
-
Set the points of the polygone 's frame definition.
- Parameters:
-
- const
- double* & iCoordinates
[in] coordinates of the points
- int
- inbPoints
[in] number of points
Returns:
Un HRESULT
- S_OK
- operation successfull
- E_FAIL
- unexpected error occured
o SetFramingAvailability
| public virtual SetFramingAvailability( | const | iAvailable) |
-
Set the availability of the frame.
- Parameters:
-
- const
- boolean iAvailable
[in] availability of the frame
- Returns:
- Un HRESULT
- S_OK
- operation successfull
- E_FAIL
- no frame available or unexpected error
o SetFramingProfileStatus
| public virtual SetFramingProfileStatus( | const | iStatus) |
-
Set the visibility of the framing profile.
- Parameters:
-
- const
- boolean iStatus
[in] if TRUE, profile will be visible
- Returns:
- Un HRESULT
- S_OK
- operation successfull
- E_FAIL
- no frame available or unexpected error
This object is included in the file: CATIDftFramingDefinition.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.