CATAnnotationUseItf Interface CATIDrwDimDimensionLine
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwDimDimensionLine
Manages the dimension line.
Role: This interface manages all parameters linked to dimension-line and symbol(s).
Method Index
- o
GetAngle()
- Gets angle.
- o
GetDimLineSecondaryPartInfos(double&,int&)
- Gets secondary part overrun and side.
- o
GetDirection(CATDrwDimRepresentation&,double*)
- Gets direction.
- o
GetDirection(CATDrwDimRepresentation&,CATBaseUnknown_var&,double&)
- Gets direction.
- o
GetEndPoint(double*)
- Gets the end point of the graphic composante which under which underlines the value.
- o
GetGraphicParameters(int&,double&)
- Gets graphic parameters.
- o
GetLeaderAngle(double*)
- Gets angle for first part of leader.
- o
GetLeaderLength(double*)
- Gets length for first part of leader.
- o
GetLeaderSymbol(int*)
- Gets leader symbol mode.
- o
GetMiddlePoint(double*)
- Gets the middle point of the dimension line main part.
- o
GetNumberOfSymbols(int&)
- Gets dimension line number of symbols.
- o
GetOrientation()
- Gets second part dimension line orientation according to the orientation reference.
- o
GetOrientationReference()
- Gets second part dimension line orientation reference.
- o
GetOverrunSide()
- Gets side for dimline overrun.
- o
GetPoints(double*,double*,double*)
- Gets dimension line points.
- o
GetPositioningInformations(double&,CATDimPositioningDomain&)
- Gets the positioning mode of the dimension line and the shift to be applied.
- o
GetRepresentation()
- Gets basic representation mode.
- o
GetStartPointOfSecondaryPart(double*)
- Gets the start point of the secondary part of the dimension line.
- o
GetSymbol(int&,int&)
- Gets extremity dimension line symbols.
- o
GetSymbolMode()
- Gets extremity dimension line symbol mode.
- o
GetSymbolsGraphicParameters(int&,double&,int&,double&)
- Gets extremity dimension line symbol graphic parameters.
- o
GetTillCenterMode(int&,CATBoolean)
- Gets if dimension line is extending till center or till value.
- o
SetAngle(double)
- Sets angle if representation mode is user defined.
- o
SetDimLineSecondaryPartInfos(double,int)
- Sets secondary part overrun and side.
- o
SetDirection(CATDrwDimRepresentation,CATBaseUnknown_var,double)
- Sets direction.
- o
SetGraphicParameters(int,double)
- Sets graphic parameters.
- o
SetLeaderAngle(double)
- Sets angle for first part of leader.
- o
SetLeaderLength(double)
- Sets length for first part of leader.
- o
SetLeaderSymbol(int)
- Sets leader symbol mode.
- o
SetNumberOfSymbols(int)
- Sets dimension line number of symbols.
- o
SetOrientation(int)
- Sets second part dimension line orientation according to the orientation reference.
- o
SetOrientationReference(int)
- Sets second part dimension line orientation reference.
- o
SetOverrunSide(int)
- Sets side for dimline overrun.
- o
SetPoints(double*,double*,double*)
- Sets dimension line points.
- o
SetPositioningDomain(CATDimPositioningDomain)
- Sets the positioning domain of the dimension line to the provided value.
- o
SetPositioningMode(CATDimPositioningMode)
- Sets the positioning mode of the dimension line to the provided value.
- o
SetPositioningShift(double)
- Sets the positioning shift of the dimension line to the provided value.
- o
SetRepresentation(int)
- Sets basic representation mode.
- o
SetSymbol(int,int)
- Sets extremity dimension line symbols.
- o
SetSymbolMode(int)
- Sets extremity dimension line symbol mode.
- o
SetSymbolsGraphicParameters(int,double,int,double)
- Sets extremity dimension line symbol graphic parameters.
- o
SetTillCenterMode(int)
- Sets if dimension line is extending till center or till value.
Methods
o GetAngle
| public virtual GetAngle( | ) |
-
Gets angle.
- Returns:
- Angle value if representation mode is user defined.
o GetDimLineSecondaryPartInfos
| public virtual GetDimLineSecondaryPartInfos( | | overrun, |
| | side) |
-
Gets secondary part overrun and side.
- Parameters:
-
- overrun
- Overrun value.
- side
- Side (1=left, 2=right).
o GetDirection
| public virtual GetDirection( | | oRepresentation, |
| | oDirection2D) |
-
Gets direction.
- Parameters:
-
- oRepresentation
- Representation mode. (see enum definition file)
Legal values:
- DrwDimUndef
- Undefined.
- DrwDimHoriz
- Horizontal.
- DrwDimVert
- Vertical.
- DrwDimAuto
- Automatic.
- DrwDimUserDefined
- User defined.
- DrwDimTrueDim
- True dimension.
- oDirection2D
- Orientation vector if user defined.
o GetDirection
| public virtual GetDirection( | | oRepresentation, |
| | oRefElem, |
| | oRefAngle) |
-
Gets direction.
- Parameters:
-
- oRepresentation
- Representation mode. (see enum definition file)
Legal values:
- DrwDimUndef
- Undefined.
- DrwDimHoriz
- Horizontal.
- DrwDimVert
- Vertical.
- DrwDimAuto
- Automatic.
- DrwDimUserDefined
- User defined.
- DrwDimTrueDim
- True dimension.
- oRefElem
- Reference element for measurement direction if user defined.
- iRefAngle
- Reference angle in degree for measurement direction if user defined.
RefAngle is relative to iRefElem direction if it exists, else is relative to view.
o GetEndPoint
| public virtual GetEndPoint( | | oEndPoint) |
-
Gets the end point of the graphic composante which under which underlines the value.
In the general case, this graphic component is the dimension line.
When the value is inside the space between symbols, method returns E_FAIL.
- Parameters:
-
- oEndPoint
- coordinates of the point.
o GetGraphicParameters
| public virtual GetGraphicParameters( | | oColor, |
| | oThickness) |
-
Gets graphic parameters.
- Parameters:
-
- oColor
- Color.
- oThickness
- Thickness.
o GetLeaderAngle
| public virtual GetLeaderAngle( | | oAngle) |
-
Gets angle for first part of leader.
- Returns:
- error returned code
- Parameters:
-
- oAngle
- Angular value.
o GetLeaderLength
| public virtual GetLeaderLength( | | oLength) |
-
Gets length for first part of leader.
- Returns:
- error returned code
- Parameters:
-
- oLength
- Length
o GetLeaderSymbol
| public virtual GetLeaderSymbol( | | oType) |
-
Gets leader symbol mode.
- Returns:
- error returned code
- Parameters:
-
- oType
- Symbol mode (see define definition file).
o GetMiddlePoint
| public virtual GetMiddlePoint( | | oMiddlePoint) |
-
Gets the middle point of the dimension line main part.
This method is available whatever the type of the dimension line: Linear, circular or, curvilinear.
The dimension line main part may be:
- The part of the dimension line between the two extremity symbols.
- The part of the dimension line starting from the unique extremity symbol. (The prolongation of the dimension line generated
by the value underlining is not take into account).
- Parameters:
-
- oMiddlePoint
- coordinates of the middle point.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- The dimension line type is incorrect: Foreshortened radius dimension is not available.
o GetNumberOfSymbols
| public virtual GetNumberOfSymbols( | | oNbSymb) |
-
Gets dimension line number of symbols.
PreCondition<\b>: Only available for diameter dimension.
- Parameters:
-
- oNbSymb
- Number of symbols (1 or 2)
- Returns:
- error returned code
o GetOrientation
| public virtual GetOrientation( | ) |
-
Gets second part dimension line orientation according to the orientation reference.
- Returns:
- Orientation.
Orientation legal values are:
- CATDrwDimOrientHorizontal
- Horizontal if reference is screen or view.
- CATDrwDimOrientVertical
- Vertical if reference is screen or view.
- CATDrwDimOrientParallel
- Parallel if reference is dimension line.
- CATDrwDimOrientPerpendicular
- Perpendicular if reference is dimension line.
- CATDrwDimOrientFixedAngle
- Given angle fixed for all orientation reference.
.
o GetOrientationReference
| public virtual GetOrientationReference( | ) |
-
Gets second part dimension line orientation reference.
- Returns:
- Orientation reference (see define definition file).
Orientation reference legal values are:
- CATDrwDimRefScreen
- Reference is the screen.
- CATDrwDimRefView
- Reference is the view.
- CATDrwDimRefDimLine
- Reference is the dimension line.
o GetOverrunSide
| public virtual GetOverrunSide( | ) |
-
Gets side for dimline overrun.
Side (1=left, 2=right).
o GetPoints
| public virtual GetPoints( | | oPtLdc1, |
| | oPtLdc2, |
| | oPtLdcc | =NULL) |
-
Gets dimension line points.
- Parameters:
-
- iPtLdc1
- First dimension line point.
- iPtLdc2
- Second dimension line point.
- iPtLdcc
- Middle dimension line point.
Value is NULL if not circular dimension line.
o GetPositioningInformations
| public virtual GetPositioningInformations( | | oShift, |
| | oDomain) |
-
Gets the positioning mode of the dimension line and the shift to be applied.
- Parameters:
-
- oShift
- Shift value.
- oDomain
- The domain of positionment ( Inside, Outside or Undef )
(see enum definition file).
- Returns:
- Returns the associativity mode: (see enum definition file)
- NoAssociativity
- if there is no associativity.
- OnFirstSelElem
- if the dimension line is associative to the first extension line of the dimension.
- OnSecondSelElem
- if the dimension line is associative to the second extension line of the dimension.
- OnGlobalElem
- if the dimension line is associative to both extension lines of the dimension.
o GetRepresentation
| public virtual GetRepresentation( | ) |
-
Gets basic representation mode.
- Returns:
- Representation mode legal values:
- CATDrwDimLine1Part
- Standard Dimension Line representation.
- CATDrwDimLine2Parts
- Dimension Line in two parts.
- CATDrwDimLeader1Part
- Dimension Line with leader one part.
- CATDrwDimLeader2Parts
- Dimension Line with leader two parts.
o GetStartPointOfSecondaryPart
| public virtual GetStartPointOfSecondaryPart( | | oStartPoint) |
-
Gets the start point of the secondary part of the dimension line. A dimension line representation mode with 2 parts has to be activated
- Parameters:
-
- oMiddlePoint
- coordinates of the middle point.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- Leader two parts mode representation or two parts mode representation are not activated on the dimension line.
o GetSymbol
| public virtual GetSymbol( | | oSymbol1, |
| | oSymbol2) |
-
Gets extremity dimension line symbols.
- Parameters:
-
- oSymbol1
- First symbol.
Legal symbol value are (see define definition file):
- CATDrwDimSymbNone
- None.
- CATDrwDimSymbOpenArrow
- Open arrow.
- CATDrwDimSymbClosedArrow
- Closed arrow.
- CATDrwDimSymbSlash
- Slash.
- CATDrwDimSymbCircle
- Circle.
- CATDrwDimSymbCircledCross
- Circled cross.
- CATDrwDimSymbTriangle
- Triangle.
- CATDrwDimSymbCross
- Cross.
- CATDrwDimSymbXCross
- .
.
- oSymbol2
- Second symbol (same legal values).
o GetSymbolMode
| public virtual GetSymbolMode( | ) |
-
Gets extremity dimension line symbol mode.
- Returns:
- Symbol mode.
Legal symbol modes are (see define definition file):
- CATDrwDimSymbAuto
- Inside or Outside the extension lines depending on the size of the dimension.
- CATDrwDimSymbIn
- Inside the extension lines as: |<--10-->|.
- CATDrwDimSymbOut
- Outside the extension lines as: ->|10|<-.
.
o GetSymbolsGraphicParameters
| public virtual GetSymbolsGraphicParameters( | | oColorSymbol1, |
| | oThicknessSymbol1, |
| | oColorSymbol2, |
| | oThicknessSymbol2) |
-
Gets extremity dimension line symbol graphic parameters.
- Parameters:
-
- oColorSymbol1
- Colorof the first symbol.
- oThicknessSymbol1
- Thickness of the first symbol.
- oColorSymbol2
- Color of the second symbol.
- oThicknessSymbol2
- Thickness of the second symbol.
o GetTillCenterMode
| public virtual GetTillCenterMode( | | oMode, |
| | bVisu | =FALSE ) |
-
Gets if dimension line is extending till center or till value.
PreCondition<\b>: Only available for diameter or radius dimension.
- Returns:
- error returned code
- Parameters:
-
- oMode
-
Legal extension modes are (see define definition file):
- CATDrwTillCenterModeAuto
- Dimension line extended till center or till value depending of what set in Standard File.
- CATDrwTillCenterModeYes
- Dimension line extended till center.
- CATDrwTillCenterModeNo
- Dimension line extended till value .
- bVisu
-
boolean to get only visual state (i.e.: till center or not till center)
.
o SetAngle
| public virtual SetAngle( | const | iAngle) |
-
Sets angle if representation mode is user defined.
- Parameters:
-
- iAngle
- Angle value.
o SetDimLineSecondaryPartInfos
| public virtual SetDimLineSecondaryPartInfos( | | overrun, |
| | side) |
-
Sets secondary part overrun and side.
- Parameters:
-
- overrun
- Overrun value.
- side
- Side (1=left, 2=right).
o SetDirection
| public virtual SetDirection( | const | iRepresentation, |
| | iRefElem, |
| | iRefAngle | =0.) |
-
Sets direction.
- Parameters:
-
- iRepresentation
- Representation mode.
Legal values: (see enum definition file)
- DrwDimUndef
- Undefined.
- DrwDimHoriz
- Horizontal.
- DrwDimVert
- Vertical.
- DrwDimAuto
- Automatic.
- DrwDimUserDefined
- User defined.
- DrwDimTrueDim
- True dimension.
- iRefElem
- Reference element for measurement direction if user defined.
- iRefAngle
- Reference angle in degree for measurement direction if user defined.
RefAngle is relative to iRefElem direction if it exists, else is relative to view.
o SetGraphicParameters
| public virtual SetGraphicParameters( | const | iColor, |
| const | iThickness) |
-
Sets graphic parameters.
- Parameters:
-
- iColor
- Color.
- iThickness
- Thickness.
o SetLeaderAngle
| public virtual SetLeaderAngle( | | iAngle) |
-
Sets angle for first part of leader.
- Returns:
- error returned code
- Parameters:
-
- iAngle
- Angular value. ( -360 < oAngle < 360 )
o SetLeaderLength
| public virtual SetLeaderLength( | | iLength) |
-
Sets length for first part of leader.
- Returns:
- error returned code
- Parameters:
-
- iLength
- Length
o SetLeaderSymbol
| public virtual SetLeaderSymbol( | | iType) |
-
Sets leader symbol mode.
- Returns:
- error returned code
- Parameters:
-
- iType
- Symbol mode (see define definition file).
o SetNumberOfSymbols
| public virtual SetNumberOfSymbols( | | iNbSymb) |
-
Sets dimension line number of symbols.
PreCondition<\b>: Only available for diameter dimension.
- Parameters:
-
- iNbSymb
- Number of symbols (valid args are only 1 or 2)
- Returns:
- error returned code
o SetOrientation
| public virtual SetOrientation( | const | iOrientation) |
-
Sets second part dimension line orientation according to the orientation reference.
- Parameters:
-
- iOrientation
- Orientation (see define definition file).
o SetOrientationReference
| public virtual SetOrientationReference( | const | iReference) |
-
Sets second part dimension line orientation reference.
- Parameters:
-
- iReference
- Orientation reference (see define definition file).
o SetOverrunSide
| public virtual SetOverrunSide( | | side) |
-
Sets side for dimline overrun.
- Parameters:
-
- side
- Side (1=left, 2=right).
o SetPoints
| public virtual SetPoints( | | iPtLdc1, |
| | iPtLdc2, |
| | iPtLdcc | =NULL) |
-
Sets dimension line points.
- Parameters:
-
- iPtLdc1
- First dimension line point.
- iPtLdc2
- Second dimension line point.
- iPtLdcc
- Middle dimension line point.
Default value is NULL.
o SetPositioningDomain
| public virtual SetPositioningDomain( | const | iDomain) |
-
Sets the positioning domain of the dimension line to the provided value.
- Parameters:
-
- iDomain
- Value of the domain (see enum definition file).
Default value is Outside.
o SetPositioningMode
| public virtual SetPositioningMode( | const | iMode) |
-
Sets the positioning mode of the dimension line to the provided value.
- Parameters:
-
- iMode
- Value of the mode (see enum definition file).
Default value is OnFirstSelElem.
o SetPositioningShift
| public virtual SetPositioningShift( | const | iShift) |
-
Sets the positioning shift of the dimension line to the provided value.
- Parameters:
-
- iShift
- Value of the shift.
Default value is 5.
o SetRepresentation
| public virtual SetRepresentation( | const | iRepresentation) |
-
Sets basic representation mode.
- Parameters:
-
- iRepresentation
- Represention mode (see define definition file).
o SetSymbol
| public virtual SetSymbol( | const | iSymbol1, |
| const | iSymbol2) |
-
Sets extremity dimension line symbols.
- Parameters:
-
- iSymbol1
- First symbol (see define definition file).
- iSymbol2
- Second symbol (see define definition file).
o SetSymbolMode
| public virtual SetSymbolMode( | const | iSymbolMode) |
-
Sets extremity dimension line symbol mode.
- Parameters:
-
- iSymbolMode
- Symbol mode (see define definition file).
o SetSymbolsGraphicParameters
| public virtual SetSymbolsGraphicParameters( | const | iColorSymbol1, |
| const | iThicknessSymbol1, |
| const | iColorSymbol2, |
| const | iThicknessSymbol2) |
-
Sets extremity dimension line symbol graphic parameters.
- Parameters:
-
- iColorSymbol1
- Color of first symbol.
- iThicknessSymbol1
- Thickness of first symbol.
- iColorSymbol2
- Color of second symbol.
- iThicknessSymbol2
- Thickness of second symbol.
o SetTillCenterMode
| public virtual SetTillCenterMode( | | iMode) |
-
Sets if dimension line is extending till center or till value.
PreCondition: Only available for diameter or radius dimension.
- Returns:
- error returned code
- Parameters:
-
- iMode
-
Legal symbol modes are (see define definition file):
- CATDrwTillCenterModeAuto
- Dimension line extended till center or till value depending of what set in Standard File.
- CATDrwTillCenterModeYes
- Dimension line extended till center.
- CATDrwTillCenterModeNo
- Dimension line extended till value.
This object is included in the file: CATIDrwDimDimensionLine.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.