All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDrwDimValue
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDrwDimValue
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwDimValue
Manages the dimension value.
Method Index
- o
GetAngle()
- Gets the angle.
- o
GetDualComponent()
- Gets the dual value.
- o
GetDualValueDisplay()
- Gets the dual value display mode.
- o
GetFaceComponent()
- Gets the main value.
- o
GetFakeComponent()
- Gets the fake value.
- o
GetOffsets(double&,double&)
- Gets value position by offsets.
- o
GetOrientation()
- Gets the orientation.
- o
GetOrientationReference()
- Gets the orientation reference.
- o
GetPosition(double*)
- Gets the value position.
- o
GetStringValue(CATUnicodeString&)
- Gets the string of the dimension.
- o
GetValue()
- Gets the numerical value measured by the dimension.
- o
SetAngle(double)
- Sets the angle.
- o
SetDualComponent(CATIDrwDimValueComponent_var)
- Sets the dual value.
- o
SetDualValueDisplay(int)
- Sets the dual value display mode.
- o
SetFaceComponent(CATIDrwDimValueComponent_var)
- Sets the main value.
- o
SetOffsets(double,double)
- Sets value position by offsets.
- o
SetOrientation(int)
- Sets the orientation.
- o
SetOrientationReference(int)
- Sets the orientation reference.
- o
SetPosition(double*)
- Sets the value position.
- o
SetValue(double)
- Sets the value.
Methods
o GetAngle
public virtual double GetAngle( | )const = 0 |
-
Gets the angle.
- Returns:
- Angle of value orientation in case of user defined orientation.
o GetDualComponent
-
Gets the dual value.
- Returns:
- Value.
o GetDualValueDisplay
public virtual int GetDualValueDisplay( | )const = 0 |
-
Gets the dual value display mode.
- Returns:
- Display mode.
Legal values are: (see define definition file)
- CATDrwDimDualNone
- Do not display dual value.
- CATDrwDimDualBellow
- Display dual value bellow main value.
- CATDrwDimDualFractional
- Display dual value bellow main value with fractionnal display.
- CATDrwDimDualSideBySide
- Display dual value and main value side by side.
o GetFaceComponent
-
Gets the main value.
- Returns:
- Value.
o GetFakeComponent
-
Gets the fake value.
- Returns:
- Value.
o GetOffsets
public virtual HRESULT GetOffsets( | double& | dc, |
| double& | dy) const = 0 |
-
Gets value position by offsets.
- Returns:
- HRESULT error returned code
If the getting 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:
-
- dc
- X offset.
- dy
- Y offset.
o GetOrientation
public virtual int GetOrientation( | )const = 0 |
-
Gets the orientation.
- Returns:
- Orientation.
= 0 : Parallel to the dimension line or Horizontal View or Screen
= 1 : Perpandicular to the dimensionline or Vertical View or Screen
= 2 : User defined, GetAngle method has to be used to get angle value.
o GetOrientationReference
public virtual int GetOrientationReference( | )const = 0 |
-
Gets the orientation reference.
- Returns:
- Orientation reference.
Legal values are: (see define definition file)
- CATDrwDimRefScreen
- Reference is the screen.
- CATDrwDimRefView
- Reference is the view.
- CATDrwDimRefDimLine
- Reference is the dimension line.
o GetPosition
public virtual void GetPosition( | double* | position) const = 0 |
-
Gets the value position.
- Parameters:
-
- position
- Position point.
o GetStringValue
-
Gets the string of the dimension.value
For feature dimension (see
CATIDrwDimDimension.GetAnalysisType) like thread dimension, the value can be a string This string, if it exists and if the fake mode is not activated, is always displayed on dimension value.
In this case, the numerical value (accessible by GetValue) is hidden.
- Parameters:
-
- oStringValue
- [out] String value.
- Returns:
- HRESULT
- S_READONLY
- Method correctly executed (the string value is read-only)
- E_FAIL
- The value of the dimension is not a string
o GetValue
public virtual double GetValue( | )const = 0 |
-
Gets the numerical value measured by the dimension.
- Returns:
- Value.
o SetAngle
public virtual void SetAngle( | const double | angle) = 0 |
-
Sets the angle.
- Parameters:
-
- angle
- Angle of value orientation in case of user defined orientation.
o SetDualComponent
-
Sets the dual value.
- Parameters:
-
- iDualComponent
- Value.
o SetDualValueDisplay
public virtual void SetDualValueDisplay( | const int | value) = 0 |
-
Sets the dual value display mode.
- Parameters:
-
- value
- Display mode.
Legal values are: (see define definition file)
- CATDrwDimDualNone
- Do not display dual value.
- CATDrwDimDualBellow
- Display dual value bellow main value.
- CATDrwDimDualFractional
- Display dual value bellow main value with fractionnal display.
- CATDrwDimDualSideBySide
- Display dual value and main value side by side.
o SetFaceComponent
-
Sets the main value.
- Parameters:
-
- iMainComponent
- Value.
o SetOffsets
public virtual HRESULT SetOffsets( | const double | dx, |
| const double | dy) = 0 |
-
Sets value position by offsets.
- Returns:
- HRESULT error returned code
If the setting 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:
-
- dx
- X offset.
- dy
- Y offset.
o SetOrientation
public virtual void SetOrientation( | const int | iOrientation) = 0 |
-
Sets the orientation.
- Parameters:
-
- iOrientation
- Orientation.
= 0 : Parallel to the dimension line or Horizontal View or Screen
= 1 : Perpandicular to the dimensionline or Vertical View or Screen
= 2 : User defined, SetAngle method has to be used to set angle value.
o SetOrientationReference
public virtual void SetOrientationReference( | const int | iReference) = 0 |
-
Sets the orientation reference.
- Parameters:
-
- iReference
- Orientation reference.
Legal values are: (see define definition file)
- CATDrwDimRefScreen
- Reference is the screen.
- CATDrwDimRefView
- Reference is the view.
- CATDrwDimRefDimLine
- Reference is the dimension line.
o SetPosition
public virtual void SetPosition( | const double* | pos) = 0 |
-
Sets the value position.
- Parameters:
-
- pos
- Position point.
o SetValue
public virtual void SetValue( | const double | value) = 0 |
-
Sets the value.
- Parameters:
-
- value
- Value.
This object is included in the file: CATIDrwDimValue.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces