CATCH
 All Classes Functions
Public Member Functions | List of all members
Catch::CatVis Class Reference

Public Member Functions

 CatVis ()
 
CAT_RESULT init ()
 
CAT_RESULT setSelectedPartTransform (double transform[12])
 
CAT_RESULT setCursorTransform (double transform[12])
 
CAT_RESULT setSelectionStateCallback (CatVisSelectStateChangeCallback callback)
 
CAT_RESULT pollVisController ()
 
CAT_RESULT attemptPartSelection ()
 
CAT_RESULT deselectAllParts ()
 
CAT_RESULT getSelectedPartOid (std::string &oid, bool &isPartSelected)
 

Constructor & Destructor Documentation

Catch::CatVis::CatVis ( )

Public constructor

Member Function Documentation

CAT_RESULT Catch::CatVis::attemptPartSelection ( )

Attempts to select a part in Teamcenter Visualization by sending a button press and release message.

Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::deselectAllParts ( )

Deselects all parts in Teamcenter Visualization

Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::getSelectedPartOid ( std::string &  oid,
bool &  isPartSelected 
)

Sets 'isPartSelected' to true if a current part is selected. If this is true, this also provides the object ID of the selected part.

Parameters
oidSet to be the object ID of the currently selected part, if one is selected
isPartSelectedSet to true if a part is selected; false otherwise.
Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::init ( )

Start up a VisController Server and connects to the client (Teamcenter Visualization)

Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::pollVisController ( )

Instructs Viscontroller to poll for new data. This should be run whenever fresh data is required from Viscontroller that isn't provided via callback.

Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::setCursorTransform ( double  transform[12])

Update cursor transformation in Teamcenter Visualization

Parameters
transformthe transform matrix the cursor will be updated to.
Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::setSelectedPartTransform ( double  transform[12])

Set transformation information for the currently a certain object to Viscontroller The first three values represent position. The second three represent orientation.

Parameters
transformthe transform matrix the object will be updated to.
Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatVis::setSelectionStateCallback ( CatVisSelectStateChangeCallback  callback)

Sets the callback to be triggered when the part selection state has changed.

Parameters
callbackthe function to be run when the selection state has changed.
Returns
Error code denoting if the method completed successfully