All Frameworks Class Hierarchy This Framework Previous Next Indexes
VisualizationBase Class CATGraphicAttributeSet
CATGraphicAttributeSet
Usage: you must use this class as is. You should never derive it.
public class CATGraphicAttributeSet
Class to create a graphic attribute.
Role: This class permits to have a graphic attribute which define
the display properties of an element. Always associated to a rep or a
graphic primitive.
Constructor and Destructor Index
- o
CATGraphicAttributeSet(unsigned int,unsigned int)
- Construct a graphic attribute.
Method Index
- o
DecreasePriority(unsigned int)
- Decrease the selection priority.
- o
GetColor()
- Retrieves the indexed color.
- o
GetColorRGBA()
- Retrieves the red, green,blue and alpha color components.
- o
GetColorRGBA(int*,int*,int*,int*)
- Retrieves the red, green, blue and alpha color components.
- o
GetLineType()
- Retrieves the line type.
- o
GetPriority()
- Retrieves the selection priority.
- o
GetThickness()
- Retrieves the thickness.
- o
GetType()
- Retrieves the type.
- o
IncreasePriority(unsigned int)
- Increase the selection priority.
- o
IsHidden()
- Retrieves the show mode.
- o
IsHighlighted()
- Retrieves the highlight mode.
- o
IsLowlighted()
- Retrieves the lowlight mode.
- o
IsNotPickable()
- Retrieves the pick mode.
- o
IsShowFree()
- Retrieves the showfree mode.
- o
IsTransparent()
- Retrieves the transparent mode.
- o
SetColor(unsigned int)
- Sets the indexed color.
- o
SetColorRGBA(int,int,int,int)
- Sets the red, green, blue and alpha components color.
- o
SetColorRGBA(unsigned int)
- Sets the red, green, blue and alpha components color.
- o
SetFixedThickness(unsigned int)
- Sets the thickness.
- o
SetHighlightMode(unsigned int)
- Sets the highlight mode.
- o
SetLineType(unsigned int)
- Sets the line type.
- o
SetLowlightMode(unsigned int)
- Sets the lowlight mode.
- o
SetPickMode(unsigned int)
- Sets the pick mode.
- o
SetShowFreeMode(unsigned int)
- Sets the showfree mode.
- o
SetShowMode(unsigned int)
- Sets the show mode.
- o
SetThickness(unsigned int)
- Sets the thickness.
- o
SetTransparentMode(unsigned int)
- Sets the transparency participation.
- o
SetType(unsigned int)
- Sets the graphic element type.
Constructor and Destructor
o CATGraphicAttributeSet
public inline CATGraphicAttributeSet( | unsigned int | iAtt | = 0xFD040400, |
| unsigned int | iRGBA | = 0x000000FF) |
-
Construct a graphic attribute.
- Parameters:
-
- iAtt
- The value coresponding to set.basic.
The default value is:
- set.extend.color : FOREGROUND ( 253, @see CATColorName ).
- set.extend.linetype : 1 (Solid).
- set.extend.thickness : 0 .
- set.extend.type : 0 (none, no participation to ZBuffer).
- set.extend.transparent : 0 (No transparency).
- set.extend.no_show : 0 (Shown).
- set.extend.lowlight : 0 (Not under intensified).
- set.extend.highlight : 0 (Not intensified).
- set.extend.no_pick : 0 (Pickable)
- set.extend.showFree : 0 (Show/NoShow taken into account).
- set.extend.priority : 4 (default slection priority).
- iRGBA
- The red, green, blue and alpha component corresponding to rvba.basic.
The default value is 255 (black and not transparent).
Used only if set.extend.color = TRUECOLOR ( 255, @see CATColorName ).
Methods
o DecreasePriority
public inline void DecreasePriority( | const unsigned int | iStep | = 1) |
-
Decrease the selection priority.
- Parameters:
-
- iStep
- The decreasing step.
Legal values: iStep ranges from 1 to n,
but set.extend.priority ranges from 0 to 15.
o GetColor
public inline unsigned int GetColor( | )const |
-
Retrieves the indexed color.
(Corresponding to set.extend.color)
o GetColorRGBA
public inline unsigned int GetColorRGBA( | )const |
-
Retrieves the red, green,blue and alpha color components.
(Corresponding to rvba.basic)
o GetColorRGBA
public inline void GetColorRGBA( | int* | oRed, |
| int* | oGreen, |
| int* | oBlue, |
| int* | oAlpha) const |
-
Retrieves the red, green, blue and alpha color components.
- Parameters:
-
- oRed
- The red component of the color.
Legal values: oRed ranges from 0 to 255.
- oGreen
- The green component of the color.
Legal values: oGreen ranges from 0 to 255.
- oBlue
- The blue component of the color.
Legal values: oBlue ranges from 0 to 255.
- oAlpha
- The alpha component of the color.
Legal values: oAlpha ranges from 0 to 255.
o GetLineType
public inline unsigned int GetLineType( | )const |
-
Retrieves the line type.
(Corresponding to set.extend.linetype)
o GetPriority
public inline unsigned int GetPriority( | )const |
-
Retrieves the selection priority.
(Corresponding to set.extend.priority)
o GetThickness
public inline unsigned int GetThickness( | )const |
-
Retrieves the thickness.
(Corresponding to set.extend.thickness)
o GetType
public inline unsigned int GetType( | )const |
-
Retrieves the type.
(Corresponding to set.extend.type)
o IncreasePriority
public inline void IncreasePriority( | const unsigned int | iStep | = 1) |
-
Increase the selection priority.
- Parameters:
-
- iStep
- The increasing step.
Legal values: iStep ranges from 1 to n,
but set.extend.priority ranges from 0 to 15.
o IsHidden
public inline unsigned int IsHidden( | )const |
-
Retrieves the show mode.
(Corresponding to set.extend.no_show)
o IsHighlighted
public inline unsigned int IsHighlighted( | )const |
-
Retrieves the highlight mode.
(Corresponding to set.extend.highlight)
o IsLowlighted
public inline unsigned int IsLowlighted( | )const |
-
Retrieves the lowlight mode.
(Corresponding to set.extend.lowlight)
o IsNotPickable
public inline unsigned int IsNotPickable( | )const |
-
Retrieves the pick mode.
(Corresponding to set.extend.no_pick)
o IsShowFree
public inline unsigned int IsShowFree( | )const |
-
Retrieves the showfree mode.
(Corresponding to set.extend.showfree)
o IsTransparent
public inline unsigned int IsTransparent( | )const |
-
Retrieves the transparent mode.
(Corresponding to set.extend.transparent)
o SetColor
public inline void SetColor( | const unsigned int | iColor | = FOREGROUND) |
-
Sets the indexed color.
- Parameters:
-
- iColor
- The index of the color.
Legal values: iColor ranges from 0 to 255.
See
CATPredefinedColorName to have predefined color.
o SetColorRGBA
public inline void SetColorRGBA( | const int | iRed, |
| const int | iGreen, |
| const int | iBlue, |
| const int | iAlpha | = 255) |
-
Sets the red, green, blue and alpha components color.
- Parameters:
-
- iRed
- The red component of the color.
Legal values: iRed ranges from 0 to 255.
- iGreen
- The green component of the color.
Legal values: iGreen ranges from 0 to 255.
- iBlue
- The blue component of the color.
Legal values: iBlue ranges from 0 to 255.
- iAlpha
- The alpha component of the color.
Legal values: iAlpha ranges from 0 to 255.
o SetColorRGBA
public inline void SetColorRGBA( | const unsigned int | iRGBA | = 255) |
-
Sets the red, green, blue and alpha components color.
- Parameters:
-
- iRGBA
- The components of the color.
o SetFixedThickness
public inline void SetFixedThickness( | const unsigned int | iThickness | = 1) |
-
Sets the thickness.
- Parameters:
-
- iThickness
- The thickness index.
Legal values: iThickness range from 1 to 8.
o SetHighlightMode
public inline void SetHighlightMode( | const unsigned int | iMode | = 0) |
-
Sets the highlight mode.
- Parameters:
-
- iMode
- The highlight mode.
Legal values: iMode ranges from 0 to 1.
- 0 = No highlight (Not intensified).
- 1 = Highlight (Intensified).
o SetLineType
public inline void SetLineType( | const unsigned int | iLinetype | = 1) |
-
Sets the line type.
- Parameters:
-
- iLinetype
- The line type.
Legal values: iLinetype ranges from 0 to 63.
- 0 or 1 = Solid.
- 2 = Dotted.
- 3 = Dashed.
- 4 = Dot-dashed.
- 5 = Phantom.
- 6 = Small-dotted.
- 7 = JIS Axis.
- 8 to 63 = Solid or application dependant.
o SetLowlightMode
public inline void SetLowlightMode( | const unsigned int | iMode | = 0) |
-
Sets the lowlight mode.
- Parameters:
-
- iMode
- The lowlight mode.
Legal values: iMode ranges from 0 to 1.
- 0 = No lowlight (Not under intensified).
- 1 = lowlight (Under intensified).
o SetPickMode
public inline void SetPickMode( | const unsigned int | iMode | = 0) |
-
Sets the pick mode.
- Parameters:
-
- iMode
- The pick mode.
Legal values: iMode ranges from 0 to 1.
- 0 = Pickable.
- 1 = Not pickable.
o SetShowFreeMode
public inline void SetShowFreeMode( | const unsigned int | iMode | = 0) |
-
Sets the showfree mode.
- Parameters:
-
- iMode
- The showfree mode.
Legal values: iMode ranges from 0 to 1.
- 0 = Show/Noshow is taken into account.
- 1 = Show/Noshow is not taken into account.
o SetShowMode
public inline void SetShowMode( | const unsigned int | iMode | = 0) |
-
Sets the show mode.
- Parameters:
-
- iMode
- The show mode.
Legal values: iMode ranges from 0 to 1.
- 0 = Shown.
- 1 = Not shown.
o SetThickness
public inline void SetThickness( | const unsigned int | iThickness | = 1) |
-
Sets the thickness.
- Parameters:
-
- iThickness
- The thickness index.
Legal values: iThickness range from 1 to 55.
o SetTransparentMode
public inline void SetTransparentMode( | const unsigned int | iMode | = 0) |
-
Sets the transparency participation.
- Parameters:
-
- iMode
- The transparency participation.
Legal values: iMode ranges from 0 to 1.
- 0 = No transparency.
- 1 = Transparency.
o SetType
public inline void SetType( | const unsigned int | iType | = 0) |
-
Sets the graphic element type.
- Parameters:
-
- itype
- The type of the graphic element.
Legal values: iType ranges from 0 to 3.
- 0 = None (no participation to ZBuffer).
- 1 = Edge (participation to ZBuffer).
- 2 = Skin (participation to ZBuffer + two-sided lighting).
- 3 = Volume (participation to ZBuffer).
This object is included in the file: CATGraphicAttributeSet.h
If needed, your Imakefile.mk should include the module: CATViz