All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisVisuInterfaces Interface CATISamImageDisplayManager
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamImageDisplayManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamImageDisplayManager
Analysis Images display management.
Role: Query this interface on the post-processor container to manage
the display of Analysis Images.
Method Index
- o
GetAmplificationMagnitude(int&,float&)
- Retrieves the current amplification magnitude for the deformation visualization.
- o
GetDeformationMode(int&)
- Retrieves the current deformation mode used for all images.
- o
GetDisplayMode(int&)
- Retrieves the current display mode.
- o
GetPreHilightMode(int&)
- Retrieves the current pre-hilight mode used for all images.
- o
GetVisuSwitchMode(int&)
- Retrieves the current visualization switch mode.
- o
HideAllImages(CATBaseUnknown*,int)
- Deactivate all activated images, starting from a root object and using the CATINavigateObject interface.
- o
RestorePreviousModes()
- Restores the previous modes (before the last SetxxxMode())for both pre-hilight and deformation modes.
- o
RollBackToShowImages(CATBaseUnknown*)
- Activate all deactivated images that are in Show mode,
starting from a root object and using the CATINavigateObject interface.
- o
SetAmplificationMagnitude(int,float)
- Sets the default values for the amplification magnitude for the deformation visualization.
- o
SetDeformationMode(int)
- Sets a new deformation mode for all images.
- o
SetDisplayMode(int)
- Activates or deactivates visualization of images.
- o
SetPreHilightMode(int)
- Sets a new pre-hilight mode for all images.
- o
SetVisuSwitchMode(int)
- Activates or deactivates automatic switch of geometry visualization.
Methods
o GetAmplificationMagnitude
public virtual HRESULT GetAmplificationMagnitude( | int& | oType, |
| float& | oValue)= 0 |
-
Retrieves the current amplification magnitude for the deformation visualization.
- Parameters:
-
- oType
- current amplification magnitude type.
- oValue
- current amplification magnitude value.
o GetDeformationMode
public virtual HRESULT GetDeformationMode( | int& | oCurrentMode)= 0 |
-
Retrieves the current deformation mode used for all images.
- Parameters:
-
- oCurrentMode
- current deformation mode
o GetDisplayMode
public virtual HRESULT GetDisplayMode( | int& | oCurrentMode)= 0 |
-
Retrieves the current display mode.
- Parameters:
-
- oCurrentMode
- current display mode
o GetPreHilightMode
public virtual HRESULT GetPreHilightMode( | int& | oCurrentMode)= 0 |
-
Retrieves the current pre-hilight mode used for all images.
- Parameters:
-
- oCurrentMode
- current pre-hilight mode.
o GetVisuSwitchMode
public virtual HRESULT GetVisuSwitchMode( | int& | oCurrentMode)= 0 |
-
Retrieves the current visualization switch mode.
- Parameters:
-
- oCurrentMode
- current switch mode
o HideAllImages
-
Deactivate all activated images, starting from a root object and using the CATINavigateObject interface.
- Parameters:
-
- iKeepShowNoShowState
- to specify wether images Show/NoShow attributes must be preserved.
- See also:
- CATINavigateObject, CATISamImage
o RestorePreviousModes
public virtual HRESULT RestorePreviousModes( | )= 0 |
-
Restores the previous modes (before the last SetxxxMode())for both pre-hilight and deformation modes.
The recommended way to use this service is :
- Set the desired modes at the initialization of your Workbench ( Init() )
- Call RestorePreviousModes() in the Dispose() method when leaving the Workbench
o RollBackToShowImages
-
Activate all deactivated images that are in Show mode,
starting from a root object and using the CATINavigateObject interface.
- Parameters:
-
- iRootObject
- the starting object. If NULL then all images are taken into account.
- See also:
- CATINavigateObject, CATISamImage
o SetAmplificationMagnitude
public virtual HRESULT SetAmplificationMagnitude( | const int | iType, |
| const float | iValue)= 0 |
-
Sets the default values for the amplification magnitude for the deformation visualization.
This will be available for all future created images.
- Parameters:
-
- iType
-
Legal values:
- 0 : defines a constant amplification factor.
- 1 : defines a constant amplification length.
- -1 : supresses constant amplification.
- iValue
- new amplification magnitude.
o SetDeformationMode
public virtual HRESULT SetDeformationMode( | int | iNewMode)= 0 |
-
Sets a new deformation mode for all images.
- Parameters:
-
- iNewMode
- new deformation mode :
Legal values:
- 0 : real deformation ( default )
- 1 : amplified deformation
o SetDisplayMode
public virtual HRESULT SetDisplayMode( | int | iNewMode)= 0 |
-
Activates or deactivates visualization of images.
- Parameters:
-
- iNewMode
- new display mode :
Legal values:
- 0 : no image is visualized
- 1 : images are visualized ( default )
o SetPreHilightMode
public virtual HRESULT SetPreHilightMode( | int | iNewMode)= 0 |
-
Sets a new pre-hilight mode for all images.
- Parameters:
-
- iNewMode
- new pre-hilight mode :
Legal values:
- 0 : no pre-Hilight ( default )
- 1 : pre-hilight
o SetVisuSwitchMode
public virtual HRESULT SetVisuSwitchMode( | int | iNewMode)= 0 |
-
Activates or deactivates automatic switch of geometry visualization.
- Parameters:
-
- iNewMode
- new switch mode :
Legal values:
- 0 : no switch is performed
- 1 : geometry is hidden when at least one image is displayed ( default )
This object is included in the file: CATISamImageDisplayManager.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID