All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisVisuInterfaces Interface CATISamImage
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamImage
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamImage
Analysis Images modification.
Role: Analysis Images have a default definition.
But modifications may be done :
For example : change the visu,the criteria,the occurrence,
the axis sytem,...
Query this interface in order to make some changes to an existing Image.
Method Index
- o
GetActivationStatus(CATBoolean&)
- Retrieves if the image is activated or not.
- o
GetAllAvailableCriteriaNames(CATString*&,int&,int&)
- Retrieves all available Criteria for the current visu type.
- o
GetAllAvailableVisuTypeNames(CATSamVisuTypeName*&,int&,int&)
- Retrieves all available Visu Types for this image (that is for a given physical type of characteristic).
- o
GetColorMap(CATISamImageColorMap*&)
- Retrieves the color map of the image.
- o
GetCriteriaName(CATString&)
- Retrieves the current Criteria.
- o
GetCurrentOccurrence(int&)
- Retrieves the current occurrence number.
- o
GetDefaultCoefficient(float&)
- Retrieves the default amplification scale factor.
- o
GetDeformCoefficient(float&)
- Retrieves the current amplification scale factor.
- o
GetDeformMode(CATBoolean&)
- Retrieves if Deformed is ON or OFF.
- o
GetDisplacementsProviders(CATLISTP(CATBaseUnknown)&)
- Retrieves the list of objects from which the displacements will be retrieved with the CATICharacCollector interface.
- o
GetSelectionGroup(CATLISTP(CATBaseUnknown)&)
- Retrieves the groups of entities on which the image is computed.
- o
GetValuesProviders(CATLISTP(CATBaseUnknown)&)
- Retrieves the list of objects from which the values will be retrieved with the CATICharacCollector interface.
- o
GetVisuTypeName(CATSamVisuTypeName&)
- Retrieves the current Visu Type.
- o
SetActivationStatus(CATBoolean)
- To activate or deactive an image.
- o
SetColorMap(CATISamImageColorMap*)
- Set the color map of the image.
- o
SetCriteriaName(CATString)
- Changes the current Criteria.
- o
SetCurrentOccurrence(int)
- Sets the current occurrence number that is for example the mode in a frequency or buckling analysis.
- o
SetDeformCoefficient(float)
- Sets the amplification scale factor.
- o
SetDeformMode(CATBoolean)
- Sets the Deform ON or OFF.
- o
SetSelectionGroup(CATLISTP(CATBaseUnknown)&)
- Sets the groups of entities on which the image will be computed.
- o
SetVisuTypeName(CATSamVisuTypeName)
- Changes the current Visu Type.
- o
UnSetColorMap()
- Only useful when the color map is shared between several images.
- o
UpdateDisplay()
- Updates the visualization of the image.
Methods
o GetActivationStatus
-
Retrieves if the image is activated or not.
- Parameters:
-
- oActivationStatus.
- TRUE if the image is activated
o GetAllAvailableCriteriaNames
public virtual HRESULT GetAllAvailableCriteriaNames( | CATString*& | oCriteriaName, |
| int& | onbString, |
| int& | oCurrentNumber)= 0 |
-
Retrieves all available Criteria for the current visu type.
Retrieves also the current Criteria.
- Parameters:
-
- oCriteriaName
- List of supported Criteria for the current visu type
- oNbString
- Number of supported Criteria
- oCurrentNumber
- Position of the current Criteria in the previous array
o GetAllAvailableVisuTypeNames
-
Retrieves all available Visu Types for this image (that is for a given physical type of characteristic).
Retrieves also the current Visu Type.
- Parameters:
-
- oVisuTypeName
- List of supported Visu Types
- oNbType
- Number of supported Visu Types
- oCurrentNumber
- Position of the current Visu Type in the previous array
- See also:
- CATSamVisuTypeName
o GetColorMap
-
Retrieves the color map of the image.
- Parameters:
-
- oColorMap
- the color map
- See also:
- CATISamImageColorMap
o GetCriteriaName
-
Retrieves the current Criteria.
- Parameters:
-
- oCriteriaName
- The current Criteria
o GetCurrentOccurrence
public virtual HRESULT GetCurrentOccurrence( | int& | oCurrentOccurrence)= 0 |
-
Retrieves the current occurrence number.
(that is for example the mode number in a frequency or buckling analysis)
- Parameters:
-
- oCurrentNumber
o GetDefaultCoefficient
public virtual HRESULT GetDefaultCoefficient( | float& | oDefaultFactor)= 0 |
-
Retrieves the default amplification scale factor.
- Parameters:
-
- oDefaultFactor.
- the default amplification scale factor
o GetDeformCoefficient
public virtual HRESULT GetDeformCoefficient( | float& | oAmplificationFactor)= 0 |
-
Retrieves the current amplification scale factor.
- Parameters:
-
- oAmplificationFactor
- the amplification scale factor
o GetDeformMode
-
Retrieves if Deformed is ON or OFF.
- Parameters:
-
- oMode.
- the deform mode
o GetDisplacementsProviders
-
Retrieves the list of objects from which the displacements will be retrieved with the CATICharacCollector interface.
- Parameters:
-
- oDisplacementsProviders.
- the list of CATICharacCollector
o GetSelectionGroup
-
Retrieves the groups of entities on which the image is computed.
- Parameters:
-
- oSamGroupList.
- the list of objects that implement the CATISamGroup interface
o GetValuesProviders
-
Retrieves the list of objects from which the values will be retrieved with the CATICharacCollector interface.
- Parameters:
-
- oValuesProviders.
- the list of CATICharacCollector
o GetVisuTypeName
-
Retrieves the current Visu Type.
- Parameters:
-
- oVisuTypeName
- The current type of visu
- See also:
- CATSamVisuTypeName
o SetActivationStatus
-
To activate or deactive an image.
- Parameters:
-
- oActivationStatus.
- TRUE if the image is activated
o SetColorMap
-
Set the color map of the image. This can be used to share color map
between several images.
- Parameters:
-
- iColorMap
- the color map
- See also:
- CATISamImageColorMap
o SetCriteriaName
-
Changes the current Criteria.
- Parameters:
-
- iCriteriaName
- The new Criteria
o SetCurrentOccurrence
public virtual HRESULT SetCurrentOccurrence( | int | iCurrentOccurrence)= 0 |
-
Sets the current occurrence number that is for example the mode in a frequency or buckling analysis.
- Parameters:
-
- iCurrentOccurrence
- The occurrence number.
o SetDeformCoefficient
public virtual HRESULT SetDeformCoefficient( | float | iAmplificationFactor)= 0 |
-
Sets the amplification scale factor.
- Parameters:
-
- iAmplificationFactor.
- the amplification scale factor
o SetDeformMode
-
Sets the Deform ON or OFF.
- Parameters:
-
- iMode.
- the deform mode
Legal values:
- Deform ON is TRUE.
- Deform OFF is FALSE.
o SetSelectionGroup
-
Sets the groups of entities on which the image will be computed.
- Parameters:
-
- oSamGroupList.
- the list of objects that implement the CATISamGroup interface
o SetVisuTypeName
-
Changes the current Visu Type.
- Parameters:
-
- iVisuTypeName
- The new type of visu
- See also:
- CATSamVisuTypeName
o UnSetColorMap
public virtual HRESULT UnSetColorMap( | )= 0 |
-
Only useful when the color map is shared between several images.
A copy of the current shared color map is done.
o UpdateDisplay
public virtual HRESULT UpdateDisplay( | )= 0 |
-
Updates the visualization of the image.
This object is included in the file: CATISamImage.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID