VisualizationController Interface CATISelectShow

Usage: you can reimplement this interface by deriving the supplied CATExtISelectShow adapter class.

interface CATISelectShow

Interface for managing the hide/show command.
Role : This interface has two goals.

  1. The hide/show command works on , and puts in show or noshow the last object of the pathelement which implements CATISelectShow. So, if you want the hide/show command to work on your object, it is necessary to implement CATISelectShow.
  2. You can implement your own function . This way, the hide/show command will put in show or noshow the object returned by this function. This second goal is optional.
NB : When the hide/show command puts in show or noshow an object, it uses the interface on this object.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index


o GetElement(CATPathElement*)
o GetElementForHideShow(CATPathElement*,CATBaseUnknown*&,int&)
Selects the object to really put in show/noshow from the user selection.
o SelectShowPostProcess(CATPathElement*,CATShowAttribut)
Post-processes a pathelement after an element has been put in Show or No Show.

Methods


o GetElement
public virtual GetElement( iPathElt)
Deprecated:
V5R13 GetElementForHideShow. Returns the object to really put in show/noshow from the user selection.
Parameters:
iPathElt
The pathelement which encloses the user selection.
Returns:
The object we really want to put in show/noshow
It is not a CATPathElement, it is the object which will be put in show or noshow.
o GetElementForHideShow
public virtual GetElementForHideShow( iPathElt,
oSelectedObject,
oPostProcess)
Selects the object to really put in show/noshow from the user selection.
Role: This method is used by the hide/show command to select the object, that will be showed or hidden, among the elements in the selected pathelement.
Parameters:
iPathElt
The pathelement which encloses the user selection.
oSelectedObject
The object you wish to put in Show or NoShow.
It is not a CATPathElement, it is the object which will be put in show or noshow.
oPostProcess
The flag that allows the call to method
, once the object has been processed by the Hide/Show command. The default implementation values this flag to 0.
Legal values :
  • 0 : the method will not be called
  • 1 : the method will be called
Returns:
  • S_OK if the operation has succeeded.
  • E_FAIL if the operation has failed.
  • E_NOTIMPL if the method is not implemented.
o SelectShowPostProcess
public virtual SelectShowPostProcess( iPathElt,
iShowAttr)
Post-processes a pathelement after an element has been put in Show or No Show.
Role : This method is called if the method has valued the flag oPostProcess to 1.
It allows the user to make some post-processing on the pathelement.
Parameters:
iPathElt
The pathelement which encloses the user selection. It is also the argument of GetElementForHideShow.
iShowAttr
The state in which the processed element has been put.
Returns:
  • S_OK if the operation has succeeded.
  • E_FAIL if the operation has failed
This object is included in the file: CATISelectShow.h
If needed, your Imakefile.mk should include the module: CATVisController

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.