All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftDimensionFactory

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

interface CATIDftDimensionFactory

Interface to create Dimensions.
Role: Use this interface to create dimension 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 license is required.

Method Index

o CreateCoordDimension(CATIDftDimensionReference*,CATMathPoint2D&,CATBoolean,CATIDftCoordDimension_var&): Create a Coordinate Dimension with the current Coordinate Dimension style formatting.
o CreateDimSystem(CATIDrwDimDimension*,CATDimSystemDefinition*,CATIDrwDimSystem_var&): Creates a dimension system with the current dimension system style formatting.
o CreateDimension(CATListPtrCATIDftDimensionReference&,CATDimDefinition*,CATIDrwDimDimension_var&): Creates a dimension with the current Dimension style formatting.
o CreateDimensionReference(CATBaseUnknown*,CATMathPoint2D&,CATIDftDimensionReference_var&): Creates a dimension reference from selected object and an indication point on this object.

Methods

o CreateCoordDimension

public virtual CreateCoordDimension(		`ipReferenceObject`,
	const	`iPos`,
		`iIs3DCoord`,
		`ohCoordDimension`)

Create a Coordinate Dimension with the current Coordinate Dimension style formatting.

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

Parameters:

ipReferenceObject: [in] Dimension reference. Typically a 2D point or a Generated vertex.
iPos: [in] The coordinates of Coordinate Dimension anchor point. Those values are given in the view axis system and expressed in mm.
iIs3DCoord: [in] Indicates whever the Coordinate Dimension displays 2D or 3D coordinates. 2D coordinates means that displayed values are expressed in the view axis system, whereas 3D coordinates are expressed in the assembly axis sytem. Notice that if the view is based on a specific axis system, this system is prefered to the assembly one. This parameter is usefull only if the reference corresponds to a Generated vertex.
ohCoordDimension: [out] Created Coordinate Dimension.

Returns:

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

o CreateDimSystem

public virtual CreateDimSystem(		`ipDimension`,
		`iSystemDef`,
		`ohSystem`)

Creates a dimension system with the current dimension system style formatting.

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

Parameters:

ipDimension: [in] First dimension to append to 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. see
ohSystem: [out] Created dimension system.

Returns:

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

o CreateDimension

public virtual CreateDimension(	const	`iSelections`,
		`ipDimParameters`,
		`ohCreatedDimension`)

Creates a dimension with the current Dimension style formatting.

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

Parameters:

iSelections: [in] List of dimension references. This list is typically composed of 1 (length or radius dimensions), to 3 elements (chamfer dimensions).
ipDimParameters: [in] Informations necessary to the dimension creation. see
ohCreatedDimension: [out] Created dimension.

Returns:

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

o CreateDimensionReference

public virtual CreateDimensionReference(		`ipObject`,
	const	`iSelectionPoint`,
		`ohDimReference`)

Creates a dimension reference from selected object and an indication point on this object. A dimension reference is used as input for other methods of this interface to specify the object to be dimensioned and the location of the indication.

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

Parameters:

ipObject: [in] Selected Object. Typically a 2D geometry, or a Generated item.
iSelectionPoint: [in] Indication point on the selected object (view coordinates in mm).
ohDimReference: [out] Created dimension reference.

Returns:

S_OK: if the reference dimension 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: CATIDftDimensionFactory.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf