All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftSpecialAnnotationFactory

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

interface CATIDftSpecialAnnotationFactory

Interface to create special 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 CreateDatumFeature(CATMathPoint2D&,CATMathPoint2D&,CATIDftDatumFeature_var&): Create a Datum Feature annotation with the current Datum Feature style formatting.
o CreateDatumTarget(CATMathPoint2D&,CATMathPoint2D&,CATIDftDatumTarget_var&): Create a Datum Target annotation with the current Datum Target formatting.
o CreateGDT(CATMathPoint2D&,CATIDftGDT_var&): Creates a Geometric Tolerance (GDT) with the current GDT style formatting.
o CreateRoughness(CATMathPoint2D&,CATIDftRough_var&): Creates a roughness symbol with the current Roughness style formatting.

Methods

o CreateDatumFeature

public virtual CreateDatumFeature(	const	`iLeaderPos`,
	const	`iPos`,
		`ospDatumFeature`)

Create a Datum Feature annotation with the current Datum Feature style formatting.

Notice that an authoring product licence is required to get this method work correctly.

Parameters:

iLeaderPos: [in] The position where to create the Datum Feature leader (view coordinates in mm).
iPos: [in] The position where to create the Datum Feature (view coordinates in mm).
ospDatumFeature: [out] The created Datum Feature.

Returns:

S_OK: A new instance of Datum Feature has been successfully created.
E_FAIL: if the operation failed (check that an authoring licence is granteed).
E_UNEXPECTED: an expected error occured.

o CreateDatumTarget

public virtual CreateDatumTarget(	const	`iLeaderPos`,
	const	`iPos`,
		`ospDatumTarget`)

Create a Datum Target annotation with the current Datum Target formatting.

Notice that an authoring product licence is required to get this method work correctly.

Parameters:

iLeaderPos: [in] The position where to create the Datum Target leader (view coordinates in mm).
iPos: [in] The position where to create the Datum Target (view coordinates in mm).
ospDatumTarget: [out] The newly created instance of Datum Target.

Returns:

S_OK: A new instance of Datum Target has been successfully created.
E_FAIL: if the operation failed (check that an authoring licence is granteed).
E_UNEXPECTED: an expected error occured.

o CreateGDT

public virtual CreateGDT(	const	`iGDTPos`,
		`ospGDT`)

Creates a Geometric Tolerance (GDT) with the current GDT style formatting.

Notice that an authoring product licence is required to get this method work correctly.

Parameters:

iGDTPos: The position where to create the GDT (view coordinates in mm).
ospGDT: The created GDT.

Returns:

S_OK: if the geometric tolerance is created.
E_FAIL: if the operation failed (check that an authoring licence is granteed).
E_UNEXPECTED: an unexpected error occured.

o CreateRoughness

public virtual CreateRoughness(	const	`iPos`,
		`ospRough`)

Creates a roughness symbol with the current Roughness style formatting.

Notice that an authoring product licence is required to get this method work correctly.

Parameters:

iPos: [in] The position where to create the roughness symbol (view coordinates in mm).
ospRough: [out] The created Roughness symbol.

Returns:

S_OK: if the roughness symbol is created.
E_FAIL: if the operation failed (check that an authoring licence is granteed).
E_UNEXPECTED: an expected error occured.

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