All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwAnnotationFactory

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDrwAnnotationFactory
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDrwAnnotationFactory

Interface to create annotation.
Role: Use this interface to create annotation in the object which implements this interface (i.e. a view).


Method Index


o CreateDatumFeature(double,double,double,double,CATUnicodeString&)
Creates a DatumFeature.
o CreateDatumTarget(double,double,double,double,CATUnicodeString&,CATUnicodeString&,int)
Creates a DatumTarget.
o CreateDftArrow(double[2],double[2],CATIDftArrow**,int,int,IUnknown*,IUnknown*)
Creates a drawing arrow.
o CreateDftBalloon(double[2],double[2],CATUnicodeString&,CATIDftBalloon**)
Creates a drawing balloon.
o CreateDftGDT(int,double[2],double[2],CATIDftLeader**,CATIDftGDT**)
Creates an empty GDT.
o CreateDftRoughness(double[2],CATIDftRough**)
Creates a roughness symbol.
o CreateDftText(double[2],CATIDftText**)
Creates a text.
o CreateDimSystem(CATIDrwDimDimension*,CATDimSystemDefinition*,CATIDrwDimSystem**)
Creates a dimension system.
o CreateDimension(CATIUnknownList*,double**,CATDrwDimType,CATDimDefinition*,CATIDrwDimDimension**,IUnknown*,int)
Creates a dimension from selected elements.
o CreateDrwAreaFill(CATLISTV(CATISpecObject_var)&,CATISpecObject_var,CATUnicodeString)
Creates an area fill.
o CreateDrwAxisLine(CATBaseUnknown_var,CATBaseUnknown_var)
Creates an Axis Line.
o CreateDrwCenterLine(CATBaseUnknown_var,CATBaseUnknown_var)
Creates a Center Line.
o CreateDrwCoordDimension(double*,CATBaseUnknown*,double*,CATIDrwCoordDimension_var&,CATBoolean)
Creates a coordinates dimension.
o CreateDrwThread(CATBaseUnknown_var,CATBaseUnknown_var,int,CATDftThreadTypeEnum)
Creates a Thread.
o CreatePicture(CATPixelImage*,double,double,CATIDrwPicture**,CATBoolean)
Creates a drawing picture.
o CreatePicture(CATVectorImage*,double,double,CATIDrwPicture**)
Creates a drawing picture.

Methods


o CreateDatumFeature
public virtual CATIDrwDatumFeature_var CreateDatumFeature(double iLeadXPos,
double iLeadYPos,
double iXPos,
double iYPos,
CATUnicodeString& iDatText) = 0
Creates a DatumFeature.
Parameters:
iLeadXPos,iLeadYPos
2D coordinates of the location of the DatumFeature leader
iXPos,iYPos
2D coordinates of the location of the DatumFeature
DatText
Balloon text
o CreateDatumTarget
public virtual CATIDrwDatumTarget_var CreateDatumTarget(double iLeadXPos,
double iLeadYPos,
double iXPos,
double iYPos,
CATUnicodeString& iUpText,
CATUnicodeString& iLowText,
int iHasDiameter) = 0
Creates a DatumTarget.
Parameters:
iLeadXPos,iLeadYPos
2D coordinates of the location of the DatumFeature leader
iXPos,iYPos
2D coordinates of the location of the DatumTarget
iUpText
DatumTarget Upper text
iLowText
DatumTarget Lower text
iHasDiameter
Diameter symbol switch
o CreateDftArrow
public virtual HRESULT CreateDftArrow( const double[2] iHeadPoint,
const double[2] iTailPoint,
CATIDftArrow** oArrow,
const int iHeadSymbol= OPEN_ARROW,
const int iTailSymbol= NOTUSED,
IUnknown* iHeadTarget= NULL,
IUnknown* iTailTarget= NULL) = 0
Creates a drawing arrow.
Parameters:
iHeadPoint
Point coordinates of the arrow head.
iHeadPoint
Point coordinates of the arrow head.
iTailPoint
Point coordinates of the arrow tail.
oArrow
Pointer on the created arrow.
iHeadSymbol
Symbol of the arrow head.
iTailSymbol
Symbol of the arrow tail.
iHeadTarget
The target element of the arrow head.
iTailTarget
The target element of the arrow tail.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o CreateDftBalloon
public virtual HRESULT CreateDftBalloon( const double[2] iLeaderPos,
const double[2] iPos,
const CATUnicodeString& iText,
CATIDftBalloon** oBalloon) = 0
Creates a drawing balloon.
Parameters:
iLeaderPos
View coordinates of the location of the balloon leader.
iPos
View coordinates of the location of the balloon.
iText
The initialization string.
oBalloon
Pointer on the created balloon.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o CreateDftGDT
public virtual HRESULT CreateDftGDT( const int iMod,
const double[2] iLeaderPos,
const double[2] iGDTPos,
CATIDftLeader** oLead,
CATIDftGDT** oGDT) = 0
Creates an empty GDT.
Parameters:
iMod
-2 no Leader, -1 automatic symbol, 0->n leader symbol. In each case, if a default exist, it is applied.
iLeaderPos
View coordinates of the location of the GDT leader.
iGDTPos
View coordinates of the location of the GDT.
oLead
created leader.
oGDT
created GDT.
o CreateDftRoughness
public virtual HRESULT CreateDftRoughness( const double[2] iPosition,
CATIDftRough** oRough) = 0
Creates a roughness symbol.
Parameters:
iPosition
[in] The position where to create the roughness symbol in view coordinates
oRough
[out, IUnknown#Release] [out] The created Roughness symbol
o CreateDftText
public virtual HRESULT CreateDftText( const double[2] iPosition,
CATIDftText** oText) = 0
Creates a text.
Parameters:
iPosition
[in] The position where to create the text in view coordinates
oText
[out, IUnknown#Release] [out] The created Text
o CreateDimSystem
public virtual HRESULT CreateDimSystem(CATIDrwDimDimension* ipDimension,
CATDimSystemDefinition* iSystemDef,
CATIDrwDimSystem** oSystem) = 0
Creates a dimension system.
Role Creates a dimension system from the dimension given in input argument. To add other dimensions to the dimension system use CATIDrwDimSystem.AddDimension method. At the end of the dimension system creation use CATIDrwDimSystem.LineUp method to take into account the dimension system parameters managing the line-up.
Parameters:
ipDimension
[in] First dimension to aggregate in the system: This dimension is a leading part in the dimension system. It gives the direction of the dimension system.
PreCondition: Only distance dimension or angular dimension are available.
PreCondition: Half dim mode is not authorized.
iSystemDef
[in] Some usefull parameters to set at creation.
oSystem
[out, CATBaseUnknown#Release] Returned dimension system
o CreateDimension
public virtual HRESULT CreateDimension(CATIUnknownList* ipiDimElements,
double** ippSelectionPoints,
CATDrwDimType iDimType,
CATDimDefinition* ipDimParameters,
CATIDrwDimDimension** oppCreatedDimension,
IUnknown* ipiLdcDirection=NULL,
int iBuildDimOrder=1) = 0
Creates a dimension from selected elements.
Parameters:
iDimElements
Array of pointers on the elements to be dimensioned
Available elements :
  • sketcher geometry.
  • geometry generated from 3D.
iSelectionPoints
Array of pointers on the selection points of each element of iDimElements.
iDimType
Type of the dimension to create
iDimParameters
Basic parameters of the dimension
oppCreatedDimension
Created dimension
iLdcDirection
Optional reference element for the direction of the dimension line. Available if iDimParameters->Orientation is set to DrwDimUserDefined.
iBuildDimOrder
Optional suppressing the CATISpecObject::Build on dimension (default: build applyed)
See also:
CATIUnknownList, CATDrwDimType, CATDimDefinition
o CreateDrwAreaFill
public virtual CATIDrwAreaFill_var CreateDrwAreaFill(CATLISTV(CATISpecObject_var)& iGeomList,
CATISpecObject_var iPattern,
CATUnicodeString iName)=0
Creates an area fill. Warning : If the pitch of the pattern is larger than the width of the profile to fill, this one is thicken.
Parameters:
iGeomList
Geometrical supports
iPattern
Pattern to be applied
iName
Name of the area fill
o CreateDrwAxisLine
public virtual CATIDrwAxisLine_var CreateDrwAxisLine(CATBaseUnknown_var iReference1,
CATBaseUnknown_var iReference2= NULL_var)=0
Creates an Axis Line.
Parameters:
iReference1
First Reference Object (2D or Generated Geometry)
iReference2
Second Reference Object (=NULL_var in case of Generated Geometry)
o CreateDrwCenterLine
public virtual CATIDrwCenterLine_var CreateDrwCenterLine(CATBaseUnknown_var iReference,
CATBaseUnknown_var iDirection= NULL_var)=0
Creates a Center Line.
Parameters:
iReference
Reference Object (2D or Generated Geometry)
iDirection
Direction Reference (2D or Generated Geometry)
o CreateDrwCoordDimension
public virtual HRESULT CreateDrwCoordDimension(double* iIndication,
CATBaseUnknown* iReference,
double* iTextLocation,
CATIDrwCoordDimension_var& oDrwCoordDimension,
CATBoolean iContext3D= CATFalse )= 0
Creates a coordinates dimension.
Parameters:
iIndication
2D coordinates of the location of reference
iIndication
External reference for the dimension
iTextLocation
2D coordinates of the location of the dimension
oDrwCoordDimension
Created dimension
iContext3D
3D coordinates are displayed if CATTrue
o CreateDrwThread
public virtual CATIDrwThread_var CreateDrwThread(CATBaseUnknown_var iReference,
CATBaseUnknown_var iDirection= NULL_var,
int iQuadrant= 1,
CATDftThreadTypeEnum iType= CATDftTaped)=0
Creates a Thread.
Parameters:
iReference
Reference Object (2D or Generated Geometry)
iDirection
Direction Reference (2D or Generated Geometry)
iQuadrant
Quadrant (equals 1 to 4)
iType
Thread Type (CATDftTaped or CATDftThreaded)
o CreatePicture
public virtual HRESULT CreatePicture(CATPixelImage* iPixelImage,
double iXPos,
double iYPos,
CATIDrwPicture** oPicture,
CATBoolean iAggregate= TRUE )= 0
Creates a drawing picture.
Parameters:
iPixelImage
The pixel image on which the picture is based.
iXPos
X coordinate of bottom left corner.
iYPos
Y coordinate of bottom left corner.
oPicture
Pointer on the created picture.
iAggregate
Should the picture be aggregated in the picture list ?
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o CreatePicture
public virtual HRESULT CreatePicture(CATVectorImage* iVectorImage,
double iXPos,
double iYPos,
CATIDrwPicture** oPicture)= 0
Creates a drawing picture.
Parameters:
iVectorImage
The vector image on which the picture is based.
iXPos
X coordinate of bottom left corner.
iYPos
Y coordinate of bottom left corner.
oPicture
Pointer on the created picture.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.

This object is included in the file: CATIDrwAnnotationFactory.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces

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