All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDrwDimSystem

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

interface CATIDrwDimSystem

Interface to manage the life cycle of dimensions used by the dimension system.

Refer to CATIDrwStackedDimSystem or CATIDrwCumulatedDimSystem to manage the properties of the dimension system. Refer to CATIDftElementInSystem to retrieve a dimension system from a dimension

See also:
See also:
See also:

Method Index

o AddDimension(CATBaseUnknown*,CATIDrwDimDimension*&,CATMathPoint2D*,CATBoolean,int): Creates and adds a dimension in the list handled by the system.
o GetDimensionsList(CATListValCATBaseUnknown_var&): Gets the whole list of dimensions handled by the system.
o GetMasterDimension(CATIDrwDimDimension**): Gets the master dimension of the dimension system.
o GetSystemType(CATDrwDimSystemType&): Gets the type of the dimension system
o LineUp(int): To ask for the dimensions in the system to be aligned.
o RemoveDimension(CATBaseUnknown*): Removes (no destruction) a dimension from the list handled by the system.

Methods

o AddDimension

public virtual AddDimension(	`ipDimElement`,
	`opDim`,
	`ipSelPoint`	`=NULL`,
	`iComplementaryAngle`	`=FALSE`,
	`iAssociativityMode`	`=1`)

Creates and adds a dimension in the list handled by the system.
Postcondition Don't forget to use LineUp method at the end of dimension system creation to take into account the line up parameters.

Parameters:

ipDimElement: [in] new element to dimension
opDim: [out] the created dimension
ipSelPoint: [in] a 2D point to resolve ambiguity in some cases
iComplementaryAngle: [in] available for angle dimension. if iComplementaryAngle=TRUE, the dimension will be created with a complementary sector ( value > CATPI)
iAssociativityMode: [in] is the dimension associative or not

o GetDimensionsList

public virtual GetDimensionsList( opDimList)

Gets the whole list of dimensions handled by the system.

Parameters:

ipDimList: [out] list of dimensions handled by the system

o GetMasterDimension

public virtual GetMasterDimension( opMasterDim)

Gets the master dimension of the dimension system. The master dimension is the dimension to move for dimension system moving. the dimension must be updated to take into account its modification, then LineUp method must be executed to propagate the moving for all others dimensions of the dimension system.

Parameters:

opmasterDim: [out, CATBaseUnknown#Release] The master dimension

o GetSystemType

public virtual GetSystemType( opSystemType)

Gets the type of the dimension system

Parameters:

opSystemType: [out] type of the system (ChainedDimSystem, StackedDimSystem, CumulatedDimSystem, ...)

o LineUp

public virtual LineUp( const iSubPart)

To ask for the dimensions in the system to be aligned.

Parameters:

iSubPart: Defines which part of the dimensions should be aligned
1 = Value
2 = Dimension line
3 = Both dimension line and value

Returns:

S_OK

The line up operation is successful.

S_FALSE

The line up is already done.

E_FAIL

if the operation failed.

o RemoveDimension

public virtual RemoveDimension( ipDimension)

Removes (no destruction) a dimension from the list handled by the system.

Parameters:

ipDimension: [in] dimension to remove from the list of dimensions

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