CATAnnotationUseItf Interface CATIDftAnnotation
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftAnnotation
This interfaces handle position, orientation and associativity of Annotation object.
Method Index
- o
GetAssociativeOrientation(CATBaseUnknown*&,CATAssProjectingMode&)
- Gets element on which associativity orientation link has been created.
- o
GetAssociativePosition(CATBaseUnknown*&,CATAssProjectingMode&)
- Gets element on which positional link has been created.
- o
GetOrientation(double*,DftOrientationReference)
- Returns the angle of an annotation.
- o
GetOrientationReference(DftOrientationReference*)
- Returns the orientation reference of an AnnotationComponent.
- o
GetPosition(double [2])
- Returns the anchor position of an annotation.
- o
GetTextBox(CATMathPoint2D&,CATMathPoint2D&,CATMathPoint2D&,CATMathPoint2D&)
- Access the bounding box of an annotation.
- o
Move(double [2],DftAssociativityMode)
- Set the anchor position of an annotation.
- o
RemoveAssociativeOrientation()
-
- o
RemoveAssociativePosition()
-
- o
Rotate(double)
- Rotate the annotation around its anchor point.
- o
SetAssociativeOrientation(CATBaseUnknown*,CATAssProjectingMode)
- Puts orientation link between the annotation and a reference.
- o
SetAssociativePosition(CATBaseUnknown*,double,boolean,CATAssPositioningBehavior,CATAssProjectingMode)
- Puts a positional link between the annotation and a reference.
- o
SetOrientation(double)
- Set the angle of an annotation.
- o
SetOrientationReference(DftOrientationReference)
- Set the orientation reference of an AnnotationComponent.
- o
SetPosition(double [2],DftAssociativityMode)
- Set the anchor position of an annotation.
Methods
o GetAssociativeOrientation
| public virtual GetAssociativeOrientation( | | oRef, |
| | oProjMode) |
-
Gets element on which associativity orientation link has been created.
- Parameters:
-
- iRef
- Element Pointed by annotation
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
- Returns:
- HRESULT
- S_OK
- Element has been found
- E_FAIL
- No element found or element coming from generative geometry
o GetAssociativePosition
| public virtual GetAssociativePosition( | | oRef, |
| | oProjMode) |
-
Gets element on which positional link has been created.
- Parameters:
-
- iRef
- Element Pointed by annotation
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
- Returns:
- HRESULT
- S_OK
- Element has been found
- E_FAIL
- No element found or element coming from generative geometry
o GetOrientation
| public virtual GetOrientation( | | oAngle, |
| | iComputeMode | = DftOrientElement) |
-
Returns the angle of an annotation.
- Parameters:
-
- oAngle
-
- iComputeMode
- By default, give orientation in the reference axis.
- See also:
-
o GetOrientationReference
| public virtual GetOrientationReference( | | oOrientReference) |
-
Returns the orientation reference of an AnnotationComponent.
- Parameters:
-
- oOrientReference
-
- See also:
-
o GetPosition
| public virtual GetPosition( | | oPosition) |
-
Returns the anchor position of an annotation.
- Parameters:
-
- oPosition
o GetTextBox
| public virtual GetTextBox( | | oPt1, |
| | oPt2, |
| | oPt3, |
| | oPt4) |
-
Access the bounding box of an annotation.
Role: Returns characteristic points of an annotation.
The points are computed without leaders, but the frame (if any) is taken into account.
Notice that in case of a dimension, the box corresponds to the dimension value text.
Note :
oPt3 -------------- oPt4
! T e x t !
oPt1 -------------- oPt2
- Parameters:
-
- oPt1
- [out] The lower left corner of the box. The values are in view coordinates, expressed in mm.
- oPt2
- [out] The lower right corner of the box. The values are in view coordinates, expressed in mm.
- oPt3
- [out] The top left corner of the box. The values are in view coordinates, expressed in mm.
- oPt4
- [out] The top left corner of the box. The values are in view coordinates, expressed in mm.
- Returns:
- HRESULT
- S_OK
- The points have been correctly computed.
- E_FAIL
- An unexpected error occured during the computation.
o Move
| public virtual Move( | const | iVecteur, |
| | AssocMode | = Override) |
-
Set the anchor position of an annotation.
- Parameters:
-
- iVecteur
- Translation vecteur.
- AssocMode
- Defines the behaviour of the move if an associativity exists.
By default, the associativity is overrided to match the new position.
- See also:
-
o RemoveAssociativeOrientation
| public virtual RemoveAssociativeOrientation( | ) |
-
o RemoveAssociativePosition
| public virtual RemoveAssociativePosition( | ) |
-
o Rotate
| public virtual Rotate( | const | iDeltaAngle) |
-
Rotate the annotation around its anchor point.
- Parameters:
-
- iDeltaAngle
o SetAssociativeOrientation
| public virtual SetAssociativeOrientation( | | iRef, |
| | iProjMode | =Ass_Contour) |
-
Puts orientation link between the annotation and a reference.
- Parameters:
-
- iRef
- The reference. All elements which implements the CATIDrwMarkupable interface can
be used (annotations, geometry, ...).
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
Default : projected on the curve.
- Returns:
- HRESULT
- S_OK
- Orientation link has been created
- E_FAIL
- No orientation link created
o SetAssociativePosition
| public virtual SetAssociativePosition( | | iRef, |
| | iDelta | =0.0, |
| | iComputeDelta | =TRUE, |
| | iPosBehavior | =Ass_Relative, |
| | iProjMode | =Ass_Contour) |
-
Puts a positional link between the annotation and a reference.
- Parameters:
-
- iRef
- The reference. All elements which implements the CATIDrwMarkupable interface can
be used (annotations, geometry, ...).
- iDelta
- Represents the distance between the reference and the annotation.
Only taken into account when iComputeDelta = FALSE.
- iComputeDelta
- TRUE (default) : the current position of the annotation is taken to compute a delta.
The annotation will not move when using this behavior.
FALSE : The anchor point of the annotation is projected on the reference and
iDelta is used. The annotation may move when using this behavior.
- iPosBehavior
- Relative or absolute.
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
Default : projected on the curve.
- Returns:
- HRESULT
- S_OK
- Positional link has been created
- E_FAIL
- No positional link created
o SetOrientation
| public virtual SetOrientation( | const | iAngle) |
-
Set the angle of an annotation.
- Parameters:
-
- iAngle
- Note : iAngle is based on the reference axis.
o SetOrientationReference
| public virtual SetOrientationReference( | const | iOrientReference) |
-
Set the orientation reference of an AnnotationComponent.
- Parameters:
-
- iOrientReference
-
- See also:
-
o SetPosition
| public virtual SetPosition( | const | iPosition, |
| | AssocMode | = Override) |
-
Set the anchor position of an annotation.
- Parameters:
-
- iPosition
- New position of the annotation
- AssocMode
- Defines the behaviour of SetPosition if an associativity exists.
By default, the associativity is overrided to match the new position.
- See also:
-
This object is included in the file: CATIDftAnnotation.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.