All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATTPSInterfaces Interface CATITPSView
System.IUnknown
|
+---CATITPSView
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSView
Interface to TPS View object.
Role: Created and manipulated in 3D, a TPS View allows to define
support plane for TPS annotations.
A TPSView is associated with a drafting view.
Method Index
- o
GetAssociativeState(CATBoolean*)
- Retrieves the Associativity state, saved or Not.
- o
GetDisplayRatio(double*)
- Retrieves DisplayRatio of the TPSView.
- o
GetDraftingView(CATIDftView**)
- Retrieves the drafting view associated to the TPSView.
- o
GetMathPlane(CATMathPlane**)
- Retrieves Plane on which this item
lies on (The Plane of the annotation).
- o
GetSet(CATITPSSet**)
- Retrieves tolerancing set the TPSView belongs too.
- o
GetTPSs(CATITPSList**)
- Retrieves the TPS that are using this TPSView as support.
- o
GetTTRS(CATITTRSList**)
- Retrieves a CATITTRSList to read a list of features
upon which is applied the current specification.
- o
GetViewType(CATTPSViewType*)
- Retrieves the type of the TPSView.
- o
IsActive(CATBoolean*)
- Retrieves the view activity.
- o
SetAssociativeState(CATBoolean)
- Sets the Associativity state, saved or Not.
- o
SetDisplayRatio(double)
- Sets the DisplayRatio for the TPSView.
- o
SetTTRS(CATITTRSList*)
- Sets the TTRS list associated to the Specification.
Methods
o GetAssociativeState
-
Retrieves the Associativity state, saved or Not.
if TRUE, the view updates when referenced geometry moves
if FALSE, there is no update of the view according geometry.
- Parameters:
-
- oAssociativeState
- The Associativity state.
o GetDisplayRatio
public virtual HRESULT GetDisplayRatio( | double* | oDisplayRatio) const = 0 |
-
Retrieves DisplayRatio of the TPSView.
- Parameters:
-
- oDisplayRatio
- The display ratio of the View.
- Returns:
- S_OK if succeded
E_FAIL if the DisplayRatio is not valuated.
o GetDraftingView
-
Retrieves the drafting view associated to the TPSView.
- Parameters:
-
- oView
- Drafting view
o GetMathPlane
-
Retrieves Plane on which this item
lies on (The Plane of the annotation).
- Parameters:
-
- oPlane
- The offset of the TPS.
- Returns:
- S_OK if succeded (oPlane must be deleted after use)
E_FAIL if oPlane is not valuated.
o GetSet
-
Retrieves tolerancing set the TPSView belongs too.
o GetTPSs
-
Retrieves the TPS that are using this TPSView as support.
- Parameters:
-
- ioList
- List of returned TPS
o GetTTRS
-
Retrieves a CATITTRSList to read a list of features
upon which is applied the current specification.
Note that this list may have a null count; in such a case,
we have to consider this specification as a TPS applied to
the whole part.
Result of this call will mostly be a singleton, but it can
also happen situations where the list size is higher than 1;
this way, we have defined a specification related to
several surfaces (regarless the order in which the surfaces
are stored)
o GetViewType
-
Retrieves the type of the TPSView.
- Parameters:
-
- oViewType
- The Type of the TPSView
- Returns:
- S_OK if succeded.
E_FAIL if view type fails.
o IsActive
-
Retrieves the view activity. Allows to known if the TPSView is the
active one (or current) in the set.
o SetAssociativeState
-
Sets the Associativity state, saved or Not.
- Parameters:
-
- iAssociativeState
- The new Associativity state.
o SetDisplayRatio
public virtual HRESULT SetDisplayRatio( | const double | iDisplayRatio) = 0 |
-
Sets the DisplayRatio for the TPSView.
- Parameters:
-
- iDisplayRatio
- The display ratio of the View.
- Returns:
- S_OK if succeded
E_FAIL otherwise
o SetTTRS
-
Sets the TTRS list associated to the Specification.
!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!!
!! The method UpdateViewAssociativityMatrix !!
!! on CATITPSViewServices interface must be called after !!
!! each time SetTTRS has been called on the view. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
This object is included in the file: CATITPSView.h