All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTPSInterfaces Interface CATITPSDefaultAnnotation

System.IUnknown
  |
  +---CATITPSDefaultAnnotation
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATITPSDefaultAnnotation

This interface is used to get information about default annotation.
Ther is two kinds of default annotation : - with a manual selection - with a selection automatic If you want to get TTRS list on a default annotation, used CATITPS::GetTTRS. else used FindPathElemInAutoSelectionMode. In this case, you will get a list of path element on all the faces pointing by the default annotation.


Method Index


o FindPathElemInAutoSelectionMode(CATSO*)
Find all the geometry on which the annotation apply to.
o GetLinkWiGeomType(CATTPSLinkWithGeomType*)
Get the type of link between the default annotation and the geometry.
o GetSearchAlgoType(CATTPSSearchAlgoType*,double*)
Get the type of search algo to find geometry on which the annotation apply to.
o IsAppliedToPathElem(CATPathElement*,CATBoolean*,CATITPSList*)
Is this default annotation pointing this geometry?.

Methods


o FindPathElemInAutoSelectionMode
public virtual HRESULT FindPathElemInAutoSelectionMode(CATSO* opSO) const = 0
Find all the geometry on which the annotation apply to. Return E_FAIL if the annotation is not a default one.
Parameters:
opSO
List of path element on all the geometry. It's an adress on a CATSO, you must have a valid pointer on a CATSO.
o GetLinkWiGeomType
public virtual HRESULT GetLinkWiGeomType(CATTPSLinkWithGeomType* oLinkWiGeom) const = 0
Get the type of link between the default annotation and the geometry. Return E_FAIL if the annotation is not a default one.
Parameters:
oLinkWiGeom
Type of link.
o GetSearchAlgoType
public virtual HRESULT GetSearchAlgoType(CATTPSSearchAlgoType* oAlgo,
double* oRadius= NULL) const = 0
Get the type of search algo to find geometry on which the annotation apply to. Return E_FAIL if the annotation is not a default one.
Parameters:
oAlgo
Type of algo.
oRadius
Value of the fillet radius for the CATTPSSATFilletsFacesOfRadius algo.
o IsAppliedToPathElem
public virtual HRESULT IsAppliedToPathElem( const CATPathElement* ipPath,
CATBoolean* obIsApplied,
CATITPSList* iopiTPSList= NULL) const = 0
Is this default annotation pointing this geometry?. Return E_FAIL if the annotation is not a default one. Give a path element on the face, and methode find if the default annotation applied on this face.
Parameters:
ipPath
The path element of the geometry.
obIsApplied
The default annotation is applied on the geometry or not.
iopiTPSList
List of TPS which are pointing on the geometry by a TTRS link. this parameter is optional. If you don't give it, method find the list.

This object is included in the file: CATITPSDefaultAnnotation.h

Copyright © 2003, Dassault Systèmes. All rights reserved.