All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface 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
GetOrientationReference()
- Gets the orientation reference.
- o
GetOrientation()
- Gets the orientation.
- 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
SetOrientationReference(int)
- Sets the orientation reference.
- o
SetOrientation(int)
- Sets the orientation.
- o
SetPosition(double*)
-
- o
SetValue(double)
- Sets the value.
Methods
o GetAngle
| public virtual GetAngle( | ) |
-
Gets the angle.
- Returns:
- Angle of value orientation in case of user defined orientation.
o GetDualComponent
| public virtual GetDualComponent( | ) |
-
Gets the dual value.
- Returns:
- Value.
o GetDualValueDisplay
| public virtual GetDualValueDisplay( | ) |
-
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
| public virtual GetFaceComponent( | ) |
-
Gets the main value.
- Returns:
- Value.
o GetFakeComponent
| public virtual GetFakeComponent( | ) |
-
Gets the fake value.
- Returns:
- Value.
o GetOffsets
| public virtual GetOffsets( | | dc, |
| | dy) |
-
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 GetOrientationReference
| public virtual GetOrientationReference( | ) |
-
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 GetOrientation
| public virtual GetOrientation( | ) |
-
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 GetPosition
| public virtual GetPosition( | | position) |
-
Gets the value position.
- Parameters:
-
- position
- Position point.
o GetStringValue
| public virtual GetStringValue( | | oStringValue) |
-
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 GetValue( | ) |
-
Gets the numerical value measured by the dimension.
- Returns:
- Value.
o SetAngle
| public virtual SetAngle( | const | angle) |
-
Sets the angle.
- Parameters:
-
- angle
- Angle of value orientation in case of user defined orientation.
o SetDualComponent
| public virtual SetDualComponent( | const | iDualComponent) |
-
Sets the dual value.
- Parameters:
-
- iDualComponent
- Value.
o SetDualValueDisplay
| public virtual SetDualValueDisplay( | const | value) |
-
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
| public virtual SetFaceComponent( | const | iMainComponent) |
-
Sets the main value.
- Parameters:
-
- iMainComponent
- Value.
o SetOffsets
| public virtual SetOffsets( | const | dx, |
| const | dy) |
-
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 SetOrientationReference
| public virtual SetOrientationReference( | const | iReference) |
-
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 SetOrientation
| public virtual SetOrientation( | const | iOrientation) |
-
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 SetPosition
| public virtual SetPosition( | const | pos) |
-
- Deprecated:
- , use CATIDrwDimDimension#MoveValue instead.
Sets the value position.
- Parameters:
-
- pos
- Position point.
o SetValue
| public virtual SetValue( | const | value) |
-
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