All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDrwAnnotation
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDrwAnnotation
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwAnnotation
Interfaces to 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()
- Returns the angle of an annotation.
- o
GetPosition(double&,double&)
- Returns the anchor position of an annotation.
- o
Move(double,double)
- Moves the anchor position of an annotation.
- o
Rotate(double)
- Rotates an annotation.
- 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)
- Sets the angle of an annotation.
- o
SetPosition(double,double)
- Set the anchor position of an annotation.
Methods
o GetAssociativeOrientation
-
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
-
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 double GetOrientation( | )= 0 |
-
Returns the angle of an annotation.
o GetPosition
public virtual void GetPosition( | double& | oXPos, |
| double& | oYPos)= 0 |
-
Returns the anchor position of an annotation.
o Move
public virtual void Move( | double | ideltaX, |
| double | ideltaY) = 0 |
-
Moves the anchor position of an annotation.
- Parameters:
-
- ideltaX,ideltaY
- Relative vector.
o Rotate
public virtual void Rotate( | double | iDeltaAngle) = 0 |
-
Rotates an annotation.
o SetAssociativeOrientation
-
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
-
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 void SetOrientation( | double | iAngle) = 0 |
-
Sets the angle of an annotation.
o SetPosition
public virtual void SetPosition( | double | iXPos, |
| double | iYPos)= 0 |
-
Set the anchor position of an annotation.
This object is included in the file: CATIDrwAnnotation.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces