All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwDimDimension

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

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


interface CATIDrwDimDimension

Manages the dimension object.


Method Index


o AddTolerance(CATUnicodeString,CATUnicodeString,int,int)
Add an alphanumerical tolerance.
o AddTolerance(double,double,int,int)
Add a numerical tolerance.
o GetAngleSector(CATDrwDimAngleSector&)
Gets angle sector (in case of angle dimension).
o GetAutoMode(int*)
Gets auto positioning mode of dimension value.
o GetClip(CATMathPoint2D&,int&)
Retrieves the clipping information through the clipping point.
o GetClipSide(int&)
Returns the kept side of a clipped dimension.
o GetConstraint()
o GetDimType()
Gets the dimension type (angle, length, and so on).
o GetDimensionLine()
Gets the dimension line.
o GetDimensionStatus(CATListOfInt&)
Retrieve the status of the dimension.
o GetDimensionalData(CATBaseUnknown*&)
Retrieve the data pointed by the dimension.
o GetExtensionLine()
Gets the extension line.
o GetInOutMode(int*)
This method is available even if the dimension has 1 extremity symbol.
o GetSymmetryMode()
Gets the symmetry mode.
o GetValue()
Gets the dimension value.
o GetValuePosition(CATMathPoint2D&,int)
Returns the default value position.
o GetView()
Gets the view in which the dimension is.
o GetViewMode()
Gets the dimension positionning mode (free or forced).
o HideDualValue()
Hide dual value.
o IsAutoModeAble(boolean*)
Check if above two methods are available.
o IsInOutModeAble(boolean*)
Check if above two methods are available.
o Move(CATIView_var)
Transfers the dimension into a given view.
o Move(double*)
Moves the dimension line according to a given offset value.
o Move(double,double)
Moves the dimension value according to a given (dx,dy) offset value.
o MoveDimLineSecondaryPart(CATMathPoint2D)
Moves the second part of dimension line at a given point.
o MoveDimensionLine(CATMathPoint2D,int)
Moves the dimension line at a given point.
o MoveValue(CATMathPoint2D,int,int)
Moves the dimension value at a given point.
o RemoveTolerance()
Remove tolerance.
o ResetValuePosition()
Sets the value position to the default-one.
o SetAngleSector(CATDrwDimAngleSector)
Sets angle sector (in case of angle dimension).
o SetAutoMode(int)
Sets auto positioning mode of dimension value.
o SetClip(CATMathPoint2D,int)
Creates a clip on the dimension at the given point, with respect to the side given by iKeptSide.
o SetConstraint(CATIDimCst_var&)
o SetInOutMode(int)
This method is available even if the dimension has 1 extremity symbol.
o SetPosition(double*)
Sets the dimension position.
o SetSymmetryMode(int)
Sets the symmetry mode.
o SetViewMode(CATDrwDimViewMode)
Sets the dimension positionning mode (free or forced).
o ShowDualValue()
Show dual value.
o UnClip()
Removes the clipping if existing.

Methods


o AddTolerance
public virtual void AddTolerance(CATUnicodeString iUpperValue,
CATUnicodeString iLowerValue,
int iMainModeDisplay,
int iDualModeDisplay) = 0
Add an alphanumerical tolerance.
Parameters:
iUpperValue
Tolerance upper value.
iLowerValue
Tolerance lower value.
iMainModeDisplay
Main value display (0=SideBySide 1= Fractional).
iDualModeDisplay
Dual value display (0=SideBySide 1= Fractional).
o AddTolerance
public virtual void AddTolerance(double iUpperValue,
double iLowerValue,
int iMainModeDisplay,
int iDualModeDisplay) = 0
Add a numerical tolerance.
Parameters:
iUpperValue
Tolerance upper value.
iLowerValue
Tolerance lower value.
iMainModeDisplay
Main value display (0=Unresolved 1= Resolved).
iDualModeDisplay
Dual value display (0=Unresolved 1= Resolved).
o GetAngleSector
public virtual void GetAngleSector(CATDrwDimAngleSector& sector)= 0
Gets angle sector (in case of angle dimension).
Parameters:
sector
Angle sector. (see enum definition file)
o GetAutoMode
public virtual HRESULT GetAutoMode(int* oMode)= 0
Gets auto positioning mode of dimension value.
Returns:
error returned code
Parameters:
iMode
Mode
1 = Not auto mode. Dimension value is always between two symbols at the creation.
2 = Auto mode. Dimension value is out of two symbols if distance of two symbols is shorter than length of value characters.
o GetClip
public virtual HRESULT GetClip(CATMathPoint2D& oClipPt,
int& oKeptSide)=0
Retrieves the clipping information through the clipping point.
Parameters:
oClipPt
[out] Clipping point
oKeptSide
[out] Kept side of the dimension. The value of this parameter can be 0 (if the dimension isn't clipped), 1 or 2. Side 1 (resp. 2) is the side of ptldc1 (resp. ptldc2) which is defined by the SetPoints and GetPoints methods on the CATIDrwDimDimensionLine interface.
Returns:
  • S_OK if everything ran ok and the dimension is clipped
  • S_FALSE if everything ran ok, but the clipping isn't clipped
  • E_FAIL if something went wrong
o GetClipSide
public virtual HRESULT GetClipSide(int& oKeptSide)=0
Returns the kept side of a clipped dimension.
Parameters:
oKeptSide
[out] Kept side of the dimension. The value of this parameter can be 0 (dimension not clipped), 1 or 2. Side 1 (resp. 2) is the side of ptldc1 (resp. ptldc2) which is defined by the SetPoints and GetPoints methods on the CATIDrwDimDimensionLine interface.
Returns:
  • S_OK if everything ran
  • E_FAIL otherwise
o GetConstraint
public virtual CATIDimCst_var GetConstraint()= 0
Deprecated:
V5R15 Gets the constraint dressed up by the dimension.
Returns:
The constraint.
o GetDimType
public virtual CATDrwDimType GetDimType()= 0
Gets the dimension type (angle, length, and so on).
Returns:
The type (see enum definition file).
o GetDimensionLine
public virtual CATIDrwDimDimensionLine_var GetDimensionLine()= 0
Gets the dimension line.
Returns:
The dimension line.
o GetDimensionStatus
public virtual HRESULT GetDimensionStatus(CATListOfInt& oListOfDimStatus) = 0
Retrieve the status of the dimension.
Parameters:
oListOfDimStatus
The list of the dimension status. the return values are defined in CATDrwDimAnalysisType
Returns:
S_OK
if the operation succeeded,
E_FAIL
if an unspecified failure occurred.
See also:
CATDrwDimAnalysisType
o GetDimensionalData
public virtual HRESULT GetDimensionalData(CATBaseUnknown*& oDimData)= 0
Retrieve the data pointed by the dimension.
Returns:
error returned code
Parameters:
oDimData
Return a handler on the data
o GetExtensionLine
public virtual CATIDrwDimExtensionLine_var GetExtensionLine()= 0
Gets the extension line.
Returns:
The extension line.
o GetInOutMode
public virtual HRESULT GetInOutMode(int* oMode)= 0
This method is available even if the dimension has 1 extremity symbol. except for cumurate dimension. Gets inside\outside mode of dimension value.
Returns:
error returned code
Parameters:
iMode
Mode
1 = Inside mode.
2 = Outside mode.
o GetSymmetryMode
public virtual int GetSymmetryMode()= 0
Gets the symmetry mode.
Returns:
The symmetry mode (1=yes, 0=no).
o GetValue
public virtual CATIDrwDimValue_var GetValue()= 0
Gets the dimension value.
Returns:
The dimension value.
o GetValuePosition
public virtual void GetValuePosition(CATMathPoint2D& pos,
int config=0 )= 0
Returns the default value position.
Parameters:
pos
Default position for dim value
config
=0: Current value position. =1: Default value position.
o GetView
public virtual CATIView_var GetView()= 0
Gets the view in which the dimension is.
Returns:
The view.
o GetViewMode
public virtual CATDrwDimViewMode GetViewMode()= 0
Gets the dimension positionning mode (free or forced).
Returns:
The dimension positionning mode (see enum definition file).
o HideDualValue
public virtual void HideDualValue()= 0
Hide dual value.
o IsAutoModeAble
public virtual HRESULT IsAutoModeAble(boolean* bMode)= 0
Check if above two methods are available.
Returns:
error returned code
Parameters:
bMode

true = Auto mode is available.
false = Otherwise.
o IsInOutModeAble
public virtual HRESULT IsInOutModeAble(boolean* bMode)= 0
Check if above two methods are available.
Returns:
error returned code
Parameters:
bMode

true = Inside\Outside mode is available.
false = Otherwise.
o Move
public virtual void Move(CATIView_var iView) = 0
Transfers the dimension into a given view.
Parameters:
iView
View in which the dimension should be transfered.
o Move
public virtual void Move(double* iPosition) = 0
Moves the dimension line according to a given offset value.
Parameters:
iPosition
Offset value (positive or negative).
o Move
public virtual HRESULT Move(double dx,
double dy=0.0 )= 0
Moves the dimension value according to a given (dx,dy) offset value.
Returns:
HRESULT error returned code If the modification of the dy value can not be performed because the parameter is locked in the current standard, the method return HRESULT = S_READ_ONLY.
Parameters:
dx
x offset value (positive or negative).
dy
y offset value (positive or negative).
o MoveDimLineSecondaryPart
public virtual void MoveDimLineSecondaryPart(CATMathPoint2D ptPos)= 0
Moves the second part of dimension line at a given point.
Parameters:
ptPos
Point on which the second part of dimension line must be positionned.
o MoveDimensionLine
public virtual void MoveDimensionLine( const CATMathPoint2D ptPos,
int iDimAngleBehavior=0) = 0
Moves the dimension line at a given point.
Parameters:
ptPos
Point on which the dimension line must be positionned.
iDimAnglBehavior
Defines angle dimension line behavior.
0 = Sector angle is switched when ptPos is in opposite sector (Default).
1 = Sector angle is kept what ever ptPos placement.
o MoveValue
public virtual HRESULT MoveValue( const CATMathPoint2D ptPos,
const int iSubPart=0,
int iDimAngleBehavior=0) = 0
Moves the dimension value at a given point.
Returns:
HRESULT error returned code If the modification of the vertical offset value can not be performed because the parameter is locked in the current standard, the method return HRESULT = S_READ_ONLY.
Parameters:
ptPos
Point on which the dimension value will be positionned.
iSubPart
Defines which part of the dimension should be moved
-1 = Value (vertical move is take account according ptPos coordinates)
0 = Both dimension line and value
1 = Value
2 = Dimension line
3 = Secondary part
4 = Secondary part and value
5 = Secondary part and dimension line
6 = Secondary part, dimension line and value
7 = Value leader (for dimension line with leader one part or two parts)
iDimAnglBehavior
Defines angle dimension line behavior.
0 = Sector angle is switched when ptPos is in opposite sector (Default)
1 = Sector angle is kept what ever ptPos placement
o RemoveTolerance
public virtual void RemoveTolerance()= 0
Remove tolerance.
o ResetValuePosition
public virtual void ResetValuePosition()= 0
Sets the value position to the default-one.
o SetAngleSector
public virtual void SetAngleSector(CATDrwDimAngleSector sector)= 0
Sets angle sector (in case of angle dimension).
Parameters:
sector
Angle sector. (see enum definition file)
o SetAutoMode
public virtual HRESULT SetAutoMode(int iMode)= 0
Sets auto positioning mode of dimension value.
Returns:
error returned code
Parameters:
iMode
Mode
1 = Not auto mode. Dimension value is always between two symbols at the creation.
2 = Auto mode. Dimension value is out of two symbols if distance of two symbols is shorter than length of value characters.
o SetClip
public virtual HRESULT SetClip( const CATMathPoint2D iClipPt,
int iKeptSide)=0
Creates a clip on the dimension at the given point, with respect to the side given by iKeptSide.
Parameters:
iClipPt
[in] Point where to apply the clipping
iKeptSide
[in] Side of the dimension to be kept. The value of this parameter can be 1 or 2. Side 1 (resp. 2) is the side of ptldc1 (resp. ptldc2) which is defined by the SetPoints and GetPoints methods on the CATIDrwDimDimensionLine interface.
Returns:
S_OK if everything ran ok, E_FAIL otherwise
o SetConstraint
public virtual void SetConstraint(CATIDimCst_var& iCst) = 0
Deprecated:
V5R15 Sets the constraint to dress up.
Parameters:
iCst
Constraint to set.
o SetInOutMode
public virtual HRESULT SetInOutMode(int iMode)= 0
This method is available even if the dimension has 1 extremity symbol. except for cumurate dimension. Sets inside\outside mode of dimension value.
Returns:
error returned code
Parameters:
iMode
Mode
1 = Inside mode.
2 = Outside mode.
o SetPosition
public virtual void SetPosition( const double* iPosition) = 0
Sets the dimension position.
Parameters:
iPosition
Position to set.
o SetSymmetryMode
public virtual void SetSymmetryMode( const int iSymmetryMode) = 0
Sets the symmetry mode.
Parameters:
iSymmetryMode
Symmetry mode to set (1=yes, 0=no).
o SetViewMode
public virtual void SetViewMode( const CATDrwDimViewMode iViewMode) = 0
Sets the dimension positionning mode (free or forced).
Parameters:
iViewMode
Positionning mode to set (see enum definition file).
o ShowDualValue
public virtual void ShowDualValue()= 0
Show dual value.
o UnClip
public virtual HRESULT UnClip()=0
Removes the clipping if existing.
Returns:
  • S_OK if everything ran ok and the dimension was clipped,
  • S_FALSE if the dimension wasn't clipped,
  • E_FAIL otherwise.

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

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