All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSBaseUseItf Interface 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 GetViewBound(CATMathPoint2D&,CATMathPoint2D&): Retrieves the ViewBound of the TPSView.
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.
o UpdateAssociativityMatrix(CATMathPlane*): Updates the transformation matrix giving the view plane from its TTRS plane This method must be called after each time SetTTRS has been called on the view, or after each call to SetProjPlane on the corresponding Drafting View.

Methods

o GetAssociativeState

public virtual GetAssociativeState( oAssociativeState)

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 GetDisplayRatio( oDisplayRatio)

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

public virtual GetDraftingView( opiView)

Retrieves the drafting view associated to the TPSView.

Parameters:

opiView: [out, CATIDftView#Release] The drafting view.

o GetMathPlane

public virtual GetMathPlane( opPlane)

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

public virtual GetSet( opiSet)

Retrieves tolerancing set the TPSView belongs too.

Parameters:

opiSet: [out, CATITPSSet#Release] The tolerancing set the TPSView belongs too.

o GetTPSs

public virtual GetTPSs( iopiList)

Retrieves the TPS that are using this TPSView as support.

Parameters:

iopiList: [inout, CATITPSList#Release] List of returned TPS.

o GetTTRS

public virtual GetTTRS( oTTRS)

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)

Parameters:

oTTRS: [out, CATITTRSList#Release] The TTRS list.

o GetViewBound

public virtual GetViewBound(		`oBottomLeftCorner`,
		`oTopRightCorner`)

Retrieves the ViewBound of the TPSView. ViewBound will include all the annotations contained in the view.

Parameters:

oBottomLeftCorner: Position of the Bottom Left corner of the view bound in the form of CATMathPoint2D, in the view plane. This value will be with respect to the view coordinate system.
oTopRightCorner: Position of the Top Right corner of the view bound in the form of CATMathPoint2D, in the view plane. This value will be with respect to the view coordinate system.

Returns:

S_OK if succeded E_FAIL if the ViewBound failed to be computed.

o GetViewType

public virtual GetViewType( oViewType)

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

public virtual IsActive( oActivity)

Retrieves the view activity. Allows to known if the TPSView is the active one (or current) in the set.

o SetAssociativeState

public virtual SetAssociativeState( const iAssociativeState)

Sets the Associativity state, saved or Not.

Parameters:

iAssociativeState: The new Associativity state.

o SetDisplayRatio

public virtual SetDisplayRatio( const iDisplayRatio)

Sets the DisplayRatio for the TPSView.

Parameters:

iDisplayRatio: The display ratio of the View.

Returns:

S_OK if succeded E_FAIL otherwise

o SetTTRS

public virtual SetTTRS( const iTTRS)

Sets the TTRS list associated to the Specification. !!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!! !! The method UpdateAssociativityMatrix !! !! on CATITPSView interface must be called after !! !! each time SetTTRS has been called on the view. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

o UpdateAssociativityMatrix

public virtual UpdateAssociativityMatrix( ipImposedViewPlane = NULL)

Updates the transformation matrix giving the view plane from its TTRS plane This method must be called after each time SetTTRS has been called on the view, or after each call to SetProjPlane on the corresponding Drafting View.

Parameters:

ipImposedViewPlane: The imposed mathematical plane for the view in the coordinates of the UIActive Object Axis System. If a part open under products is edited, the global axis system is the one of the root product, whereas the UIActive Object Axis System is the one of the part. If NULL, the plane will be chosen according to the present point of view of the geometry for the user.

Returns:

S_OK if succeded. E_FAIL if view type fails.

This object is included in the file: CATITPSView.h