All Frameworks  Class Hierarchy  This Framework  Indexes   

CATAnalysisVisuInterfaces Interface CATISamImageAttributes

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISamImageAttributes

Analysis Images modification.
Role: Analysis Images have a default definition.
But modifications may be done :
For example change the symbol iso or fringe attributes,...
Query this interface in order to make some changes to an existing Image.


Method Index


o GetDisplayElementOutsideSelection(CATBoolean&)
Retrieves if elements (or faces) outside selection are drawn.
o GetDisplayElementWithoutValue(CATBoolean&)
Retrieves if elements (or faces) without values are drawn.
o GetMinSymbolLength(float&)
Retrieves the min size of symbol displayed.
o GetShrinkCoefficient(float&)
Retrieves the shrink coefficient.
o GetSymbolColorType(CATSamColorType&)
Gets information about the color of symbols.
o GetSymbolFixedColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Gets the red, green, blue and alpha components color, used when fixed color is choosen for symbols.
o GetSymbolLengthVariation(CATBoolean&)
Retrieves if the size of symbols displayed is fixed or variable.
o GetSymbolLength(float&)
Retrieves the size of symbol displayed.
o GetSymbolType(CATSamSymbolType&)
Retrieves the type of symbol displayed.
o GetTextColorType(CATSamColorType&)
Gets information about the color of texts.
o GetTextFixedColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Gets the red, green, blue and alpha components color, used when fixed color is choosen for texts.
o GetZoomSensitivity(CATBoolean&)
Retrieves if the size of symbols displayed is fixed or not with Zoom
o SetDisplayElementOutsideSelection(CATBoolean)
Sets if elements (or faces) outside selection have to be drawn.
o SetDisplayElementWithoutValue(CATBoolean)
Sets if elements (or faces) without values have to be drawn.
o SetMinSymbolLength(float)
Defines the min size of symbol to display.
o SetShrinkCoefficient(float)
Sets the shrink coefficient.
o SetSymbolColorType(CATSamColorType)
Defines the type of color for symbols.
o SetSymbolFixedColor(unsigned int,unsigned int,unsigned int,unsigned int)
Sets the red, green, blue and alpha components color, used when fixed color is choosen for symbols.
o SetSymbolLengthVariation(CATBoolean)
Sets if the size of symbols to display is fixed or variable.
o SetSymbolLength(float)
Defines the size of symbol to display.
o SetSymbolType(CATSamSymbolType)
Defines the type of symbol to display.
o SetTextColorType(CATSamColorType)
Defines the type of color for texts.
o SetTextFixedColor(unsigned int,unsigned int,unsigned int,unsigned int)
Sets the red, green, blue and alpha components color, used when fixed color is choosen for texts.
o SetZoomSensitivity(CATBoolean)
Sets if the size of symbols to display is fixed or not with Zoom

Methods


o GetDisplayElementOutsideSelection
public virtual GetDisplayElementOutsideSelection( oDisplayTrueOrFalse)
Retrieves if elements (or faces) outside selection are drawn. This option is used for iso-pattern or fringe visu (Color used for those elements is WHITE)
Parameters:
oDisplayTrueOrFalse
The display mode choosen
o GetDisplayElementWithoutValue
public virtual GetDisplayElementWithoutValue( oDisplayTrueOrFalse)
Retrieves if elements (or faces) without values are drawn. This option is used for iso-pattern or fringe visu (Color used for those elements is WHITE)
Parameters:
oDisplayTrueOrFalse
The display mode choosen
o GetMinSymbolLength
public virtual GetMinSymbolLength( oMinSymbolLength)
Retrieves the min size of symbol displayed.
Parameters:
oMinSymbolLength
This float represents:
the length associated to the smallest value if length is variable
o GetShrinkCoefficient
public virtual GetShrinkCoefficient( oShrinkCoefficient)
Retrieves the shrink coefficient.
Parameters:
oShrinkCoefficient
the shrink coefficient associated
o GetSymbolColorType
public virtual GetSymbolColorType( oColorType)
Gets information about the color of symbols. That is, if the color is Fixed or Variable.
Parameters:
oColorType
The current type of color.
See also:
CATSamColorType
o GetSymbolFixedColor
public virtual GetSymbolFixedColor( oRedColor,
oGreenColor,
oBlueColor,
oAlphaColor)
Gets the red, green, blue and alpha components color, used when fixed color is choosen for symbols.
Parameters:
oRedColor
The red component of the color.
oGreenColor
The green component of the color.
oBlueColor
The blue component of the color.
oAlphaColor
The alpha component of the color.
o GetSymbolLengthVariation
public virtual GetSymbolLengthVariation( oVariationTrueOrFalse)
Retrieves if the size of symbols displayed is fixed or variable.
Parameters:
oVariationTrueOrFalse
The size is VARIABLE or not
o GetSymbolLength
public virtual GetSymbolLength( oSymbolLength)
Retrieves the size of symbol displayed.
Parameters:
oSymbolLength
This float represents:
the length associated to the biggest value if length is variable
the length associated to all the symbols if length is fixed
o GetSymbolType
public virtual GetSymbolType( oSymbolType)
Retrieves the type of symbol displayed.(CATSamSymbolType_SingleArrow/CATSamSymbolType_DoubleArrow/...)
Parameters:
oSymbolType
The current type of symbol.
See also:
CATSamSymbolType
o GetTextColorType
public virtual GetTextColorType( oColorType)
Gets information about the color of texts. That is, if the color is Fixed or Variable.
Parameters:
oColorType
The current type of color.
See also:
CATSamColorType
o GetTextFixedColor
public virtual GetTextFixedColor( oRedColor,
oGreenColor,
oBlueColor,
oAlphaColor)
Gets the red, green, blue and alpha components color, used when fixed color is choosen for texts.
Parameters:
oRedColor
The red component of the color.
oGreenColor
The green component of the color.
oBlueColor
The blue component of the color.
oAlphaColor
The alpha component of the color.
o GetZoomSensitivity
public virtual GetZoomSensitivity( oSensitivityTrueOrFalse)
Retrieves if the size of symbols displayed is fixed or not with Zoom
Parameters:
oSensitivityTrueOrFalse
The size changes with ZOOM or not
o SetDisplayElementOutsideSelection
public virtual SetDisplayElementOutsideSelection( iDisplayTrueOrFalse)
Sets if elements (or faces) outside selection have to be drawn. This option is used for iso-pattern or fringe visu (Color used for those elements is WHITE)
Parameters:
iDisplayTrueOrFalse
Legal value: Element DISPLAYED is TRUE.
Legal value: Element NOT DISPLAYED is FALSE.
o SetDisplayElementWithoutValue
public virtual SetDisplayElementWithoutValue( iDisplayTrueOrFalse)
Sets if elements (or faces) without values have to be drawn. This option is used for iso-pattern or fringe visu (Color used for those elements is WHITE)
Parameters:
iDisplayTrueOrFalse
Legal value: Element DISPLAYED is TRUE.
Legal value: Element NOT DISPLAYED is FALSE.
o SetMinSymbolLength
public virtual SetMinSymbolLength( iMinSymbolLength)
Defines the min size of symbol to display.
Parameters:
iMinSymbolLength
This float represents:
the length associated to the smallest value if length is variable
o SetShrinkCoefficient
public virtual SetShrinkCoefficient( iShrinkCoefficient)
Sets the shrink coefficient.
Parameters:
iShrinkCoefficient
the shrink coefficient to define
o SetSymbolColorType
public virtual SetSymbolColorType( iColorType)
Defines the type of color for symbols. That is, if the color is Fixed or Variable.
Parameters:
iColorType
The current type of color.
See also:
CATSamColorType
o SetSymbolFixedColor
public virtual SetSymbolFixedColor( const iRedColor,
const iGreenColor,
const iBlueColor,
const iAlphaColor=255)
Sets the red, green, blue and alpha components color, used when fixed color is choosen for symbols.
Parameters:
iRedColor
The red component of the color.
Legal values: iRedColor ranges from 0 to 255.
iGreenColor
The green component of the color.
Legal values: iGreenColor ranges from 0 to 255.
iBlueColor
The blue component of the color.
Legal values: iBlueColor ranges from 0 to 255.
iAlphaColor
The alpha component of the color.
Legal values: iAlphaColor ranges from 0 to 255.
Default value: iAlphaColor is 255.
o SetSymbolLengthVariation
public virtual SetSymbolLengthVariation( iVariationTrueOrFalse)
Sets if the size of symbols to display is fixed or variable.
Parameters:
iVariationTrueOrFalse
The size is VARIABLE or not
Legal value: VARIABLE Length is TRUE.
Legal value: FIXED Length is FALSE.
o SetSymbolLength
public virtual SetSymbolLength( iSymbolLength)
Defines the size of symbol to display.
Parameters:
iSymbolLength
This float represents:
the length associated to the biggest value if length is variable
the length associated to all the symbols if length is fixed
o SetSymbolType
public virtual SetSymbolType( iSymbolType)
Defines the type of symbol to display. (CATSamSymbolType_SingleArrow/CATSamSymbolType_DoubleArrow/...)
Parameters:
iSymbolType
The current type of symbol.
See also:
CATSamSymbolType
o SetTextColorType
public virtual SetTextColorType( iColorType)
Defines the type of color for texts. That is, if the color is Fixed or Variable.
Parameters:
iColorType
The current type of color.
See also:
CATSamColorType
o SetTextFixedColor
public virtual SetTextFixedColor( const iRedColor,
const iGreenColor,
const iBlueColor,
const iAlphaColor=255)
Sets the red, green, blue and alpha components color, used when fixed color is choosen for texts.
Parameters:
iRedColor
The red component of the color.
Legal values: iRedColor ranges from 0 to 255.
iGreenColor
The green component of the color.
Legal values: iGreenColor ranges from 0 to 255.
iBlueColor
The blue component of the color.
Legal values: iBlueColor ranges from 0 to 255.
iAlphaColor
The alpha component of the color.
Legal values: iAlphaColor ranges from 0 to 255.
Default value: iAlphaColor is 255.
o SetZoomSensitivity
public virtual SetZoomSensitivity( iSensitivityTrueOrFalse)
Sets if the size of symbols to display is fixed or not with Zoom
Parameters:
iSensitivityTrueOrFalse
The size changes with ZOOM or not
Legal value: sensitivity with ZOOM is TRUE.
Legal value: NO sensitivity with ZOOM is FALSE.

This object is included in the file: CATISamImageAttributes.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID

Copyright © 2003, Dassault Systèmes. All rights reserved.