CATAnnotationUseItf Interface CATIDftBaseAnnotationFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftBaseAnnotationFactory
Interface to create basic annotations.
Role: Use this interface to create annotation in the object which
implements this interface (i.e. a drafting view, a 2D Layout for 3D Design view, or a 2D Component).
Notice that an authoring product licence is required.
Method Index
- o
CreateArrow(CATMathPoint2D&,CATMathPoint2D&,CATIDftArrow_var&)
- Creates an arrow with the current Arrow style formatting.
- o
CreateBalloon(CATMathPoint2D&,CATMathPoint2D&,CATIDftBalloon_var&)
- Creates a balloon with the current Ballon style formatting.
- o
CreateText(CATMathPoint2D&,CATIDftText_var&)
- Creates a text with the current Text style formatting.
- o
InstantiateText(CATIDftText*,CATIDftText_var&)
- Instantiates a text from the given template.
Methods
o CreateArrow
| public virtual CreateArrow( | const | iHeadPos, |
| const | iTailPos, |
| | ospArrow) |
-
Creates an arrow with the current Arrow style formatting.
- Notice that an authoring product licence is required to get this method work correctly.
- Parameters:
-
- iHeadPos
- Position where the arrow head must be located (view coordinates in mm).
- iTailPos
- Position where the arrow tail must be located (view coordinates in mm).
- ospArrow
- The created arrow.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed (check that an authoring licence is granteed).
- E_UNEXPECTED
- an unexpected error occured.
o CreateBalloon
| public virtual CreateBalloon( | const | iLeaderPos, |
| const | iPos, |
| | ospBalloon) |
-
Creates a balloon with the current Ballon style formatting.
- Notice that an authoring product licence is required to get this method work correctly.
- Parameters:
-
- iLeaderPos
- Position where the balloon leader extremity must be located (view coordinates in mm).
- iPos
- Position where the balloon must be located (view coordinates in mm).
- ospBalloon
- The created balloon.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed (check that an authoring licence is granteed).
- E_UNEXPECTED
- an unexpected error occured.
o CreateText
| public virtual CreateText( | const | iPosition, |
| | ospText) |
-
Creates a text with the current Text style formatting.
- Notice that an authoring product licence is required to get this method work correctly.
- Parameters:
-
- iPosition
- [in] The position where to create the text (view coordinates in mm)
- ospText
- [out] The created Text
- Returns:
-
- S_OK
- if the text is created.
- E_FAIL
- if the operation failed (check that an authoring licence is granteed).
- E_UNEXPECTED
- an unexpected error occured.
o InstantiateText
| public virtual InstantiateText( | | ipTemplate, |
| | ospText) |
-
Instantiates a text from the given template.
- Notice that an authoring product licence is required to get this method work correctly.
- Parameters:
-
- ipTemplate
- [in] The template to be instantiated
- ospText
- [out] The created Text
- Returns:
-
- S_OK
- if the text is created.
- E_FAIL
- if the operation failed (check that an authoring licence is granteed).
- E_UNEXPECTED
- an unexpected error occured.
This object is included in the file: CATIDftBaseAnnotationFactory.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.