All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDrwDimDimensionLineForshortened
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DraftingInterfaces.CATIDrwDimDimensionLine
|
+---CATIDrwDimDimensionLineForshortened
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwDimDimensionLineForshortened
Manages the forshortened dimension line.
Method Index
- o
GetBeginingPoint(double [2])
- Gets the starting point of the forshorten line.
- o
GetFShortAngle()
- Gets dimension line angle.
- o
GetMoveBehavior(int*)
- Sets the behavior of starting point of the forshorten line when the dimension moves.
- o
GetSegmentOrientationMode()
- Gets segment orientation mode.
- o
GetSegmentRatio()
- Gets segment ratio.
- o
GetSymbolScale()
- Gets symbol scale.
- o
GetValueLocationMode()
- Gets dimension value location mode.
- o
SetBeginingPoint(double [2])
- Sets the starting point of the forshorten line.
- o
SetFShortAngle(double)
- Sets dimension line angle.
- o
SetMoveBehavior(int)
- Sets the behavior of starting point of the forshorten line when the dimension moves.
- o
SetSegmentOrientationMode(int)
- Sets segment orientation mode.
- o
SetSegmentRatio(double)
- Sets segment ratio.
- o
SetSymbolScale(double)
- Sets symbol scale.
- o
SetValueLocationMode(int)
- Sets dimension value location mode.
Methods
o GetBeginingPoint
public virtual HRESULT GetBeginingPoint( | double [2] | oForshortenCenter)= 0 |
-
Gets the starting point of the forshorten line.
- Parameters:
-
- oForshortenCenter
- Starting point.
o GetFShortAngle
public virtual double GetFShortAngle( | )const = 0 |
-
Gets dimension line angle.
- Returns:
- Angle.
o GetMoveBehavior
public virtual HRESULT GetMoveBehavior( | int* | oBehavior)= 0 |
-
Sets the behavior of starting point of the forshorten line when the dimension moves.
- Parameters:
-
- oBehavior
- FshStartPointMove (value 1) the starting point can move when dimension moves.
FshStartPointStill (value 2) the starting point moves when dimension moves.
- Returns:
- E_FAIL if impossible geometry.
o GetSegmentOrientationMode
public virtual int GetSegmentOrientationMode( | )const = 0 |
-
Gets segment orientation mode.
- Returns:
- This method manages the second segment.
Orientation mode legal values are (see define definition file):
- CATDrwDimFShortParallel
- Second segment is parallel to the first one.
- CATDrwDimFShortConvergent
- Second segment converges to the circle center.
o GetSegmentRatio
public virtual double GetSegmentRatio( | )const = 0 |
-
Gets segment ratio.
- Returns:
- Ratio between first and second segment.
o GetSymbolScale
public virtual double GetSymbolScale( | )const = 0 |
-
Gets symbol scale.
- Returns:
- Scale.
o GetValueLocationMode
public virtual int GetValueLocationMode( | )const = 0 |
-
Gets dimension value location mode.
- Returns:
- The forshortened dimension line is made of 3 segments:
- the one which is near the circle center is called the first segment.
- the one which is near the circle arc is called the second segment.
- the one in the middle is not named.
Dimension value location mode legal values are (see define definition file):
- CATDrwDimFShortFirstSeg
- located on first dimension line segment.
- CATDrwDimFShortSecondSeg
- located on second dimension line segment.
o SetBeginingPoint
public virtual HRESULT SetBeginingPoint( | const double [2] | iForshortenCenter)= 0 |
-
Sets the starting point of the forshorten line.
This point can move if the dimension moves. To prevent this
use the SetMoveBehavior method.
- Parameters:
-
- iForshortenCenter
- Starting point.
- Returns:
- E_FAIL if impossible geometry (no change occurs).
o SetFShortAngle
public virtual void SetFShortAngle( | const double | iFShortAngle)= 0 |
-
Sets dimension line angle.
- Parameters:
-
- iFShortAngle
- Angle.
o SetMoveBehavior
public virtual HRESULT SetMoveBehavior( | const int | iBehavior)= 0 |
-
Sets the behavior of starting point of the forshorten line when the dimension moves.
- Parameters:
-
- iBehavior
- FshAuto (value 1 default) the starting point is computed when dimension moves.
FshFix (value 2) the starting point doesn't move when dimension moves.
FshMove (Value 3) the starting point is computed moves when dimension moves.
o SetSegmentOrientationMode
public virtual void SetSegmentOrientationMode( | const int | iSegmentOrientationMode)= 0 |
-
Sets segment orientation mode.
- Parameters:
-
- iSegmentOrientationMode
- Orientation mode (see define definition file).
o SetSegmentRatio
public virtual void SetSegmentRatio( | const double | iSegmentRatio)= 0 |
-
Sets segment ratio.
- Parameters:
-
- iSegmentRatio
- Ratio between first and second segment.
o SetSymbolScale
public virtual void SetSymbolScale( | const double | iSymbolScale)= 0 |
-
Sets symbol scale.
- Parameters:
-
- iSymbolScale
- Scale.
o SetValueLocationMode
public virtual void SetValueLocationMode( | const int | iValueLocationMode)= 0 |
-
Sets dimension value location mode.
- Parameters:
-
- iValueLocationMode
- Location mode (see define definition file).
This object is included in the file: CATIDrwDimDimensionLineForshortened.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces