DraftingUseItf Interface CATIDftDitto
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftDitto
Interface of 2D Ditto.
Role: This interface is used to access a Drafting 2D Ditto
properties.
Method Index
- o
Get2DAxisMatrix(double[6])
- Gets the position matrix of the ditto.
- o
GetDetail(IID&,IUnknown**)
- Gets the associated detail.
- o
GetDittoFlip(CATBoolean&)
- Gets the flip state of the ditto.
- o
GetDittoPosition(double&,double&)
- Gets the ditto position.
- o
GetDittoRotation(double&)
- Gets the angle of the ditto.
- o
GetDittoScale(double&)
- Gets the ditto scale.
- o
GetListOfModifiableObjects(CATIUnknownList**)
- Gets the list of objects modifiable in the ditto.
- o
SetDittoFlip(CATBoolean)
- Manages the flip of the ditto.
- o
SetDittoPosition(double,double,CATBoolean)
- Sets the ditto position.
- o
SetDittoRotation(double,CATBoolean)
- Sets the angle of the ditto.
- o
SetDittoScale(double,CATBoolean)
- Sets the ditto scale.
Methods
o Get2DAxisMatrix
| public virtual Get2DAxisMatrix( | | oMatrix) |
-
Gets the position matrix of the ditto.
- Parameters:
-
- oMatrix
- [out] The current position matrix of the ditto.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetDetail
| public virtual GetDetail( | const | iIID, |
| | oDetail) |
-
Gets the associated detail.
Role: The detail is the reference object of instance (Ditto).
- Parameters:
-
- iIID
- [in] The interface identifier for which a pointer is requested.
- oDetail
- [out] The address where the returned pointer to the interface is located.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetDittoFlip
| public virtual GetDittoFlip( | | obFlip) |
-
Gets the flip state of the ditto.
- Parameters:
-
- obFlip
- [out] If the boolean is true the ditto is fliped.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetDittoPosition
| public virtual GetDittoPosition( | | oXposition, |
| | oYposition) |
-
Gets the ditto position.
- Parameters:
-
- oXposition
- [out] X Coordinate of the ditto position.
- oYposition
- [out] Y Coordinate of the ditto position.
- Returns:
-
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetDittoRotation
| public virtual GetDittoRotation( | | oRotation) |
-
Gets the angle of the ditto.
- Parameters:
-
- oRotation
- [out] The angle of the ditto.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetDittoScale
| public virtual GetDittoScale( | | oScale) |
-
Gets the ditto scale.
- Parameters:
-
- oScale
- [out] The scale applied to the ditto.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o GetListOfModifiableObjects
| public virtual GetListOfModifiableObjects( | | oListOfObjects) |
-
Gets the list of objects modifiable in the ditto.
Role: This method returns the list of features modifiable in the Ditto.
The list is created even if the ditto does not contain any object modifiable in the instance.
- Parameters:
-
- oListOfObjects
- The list of objects.
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o SetDittoFlip
| public virtual SetDittoFlip( | | ibUpdateVisu | =TRUE) |
-
Manages the flip of the ditto.
Role: Flips the ditto around X axis
To flip around Y axis you have to flip the component around
X and to add a rotation of 180 degrees.
- Parameters:
-
- ibUpdateVisu
- [in] If the boolean is true the visualiztion of the ditto is updated (Default mode)
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o SetDittoPosition
| public virtual SetDittoPosition( | const | iXposition, |
| const | iYposition, |
| | ibUpdateVisu | =TRUE) |
-
Sets the ditto position.
- Parameters:
-
- iXposition
- [in] X Coordinate of the ditto position.
- iYposition
- [in] Y Coordinate of the ditto position.
- ibUpdateVisu
- [in] If the boolean is true the visualiztion of the ditto is updated (Default mode)
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o SetDittoRotation
| public virtual SetDittoRotation( | const | iRotation, |
| | ibUpdateVisu | =TRUE) |
-
Sets the angle of the ditto.
- Parameters:
-
- iRotation
- [in] The angle of the ditto.
- ibUpdateVisu
- [in] If the boolean is true the visualiztion of the ditto is updated (Default mode)
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
o SetDittoScale
| public virtual SetDittoScale( | const | iScale, |
| | ibUpdateVisu | =TRUE) |
-
Sets the ditto scale.
- Parameters:
-
- iScale
- [in] The scale applied to the ditto.
- ibUpdateVisu
- [in] If the boolean is true the visualiztion of the ditto is updated (Default mode)
- Returns:
- HRESULT
- S_OK
- if the operation is successful.
- E_FAIL
- if the operation is failed.
This object is included in the file: CATIDftDitto.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.