Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

VisualizationInterfaces CATVisPropertiesValues

Usage: you must use this class as is. You should never derive it.

public class CATVisPropertiesValues

Class to represent a set of graphic properties.
Role: This class is used in the , and in the methods.

See also:

Constructor and Destructor Index

o CATVisPropertiesValues(): Constructs a graphic property set.

Method Index

o GetColor(unsigned int&,unsigned int&,unsigned int&): Retrieves the color.
o GetInheritance(CATVisPropertyType,unsigned int&): Retrieves the inheritance flag for a given property.
o GetLayer(unsigned int&): Retrieves the layer number.
o GetLineType(unsigned int&): Retrieves the line type.
o GetOpacity(unsigned int&): Retrieves the opacity value.
o GetPickAttr(CATPickAttribut&): Retrieves the pick flag.
o GetShowAttr(CATShowAttribut&): Retrieves the show flag.
o GetSymbolType(CATSymbolType&): Retrieves the point symbol.
o GetWidth(unsigned int&): Retrieves the line width.
o ResetColor(): Resets the color.
o ResetInheritance(): Resets all inheritance flags.
o ResetLayer(): Resets the layer value.
o ResetLineType(): Resets the line type.
o ResetOpacity(): Resets the opacity value.
o ResetPickAttr(): Resets the pick flag.
o ResetShowAttr(): Resets the show flag.
o ResetSymbolType(): Resets the point symbol.
o ResetWidth(): Resets the line width.
o SetColor(unsigned int,unsigned int,unsigned int,unsigned int): Sets the color.
o SetInheritance(CATVisPropertyType,unsigned int): Sets the inheritance flag for a given property.
o SetLayer(unsigned int): Sets the layer number.
o SetLineType(unsigned int,unsigned int): Sets the line type.
o SetOpacity(unsigned int,unsigned int): Sets the opacity value.
o SetPickAttr(CATPickAttribut): Sets the pick flag.
o SetShowAttr(CATShowAttribut): Sets the show flag.
o SetSymbolType(CATSymbolType): Sets the point symbol.
o SetWidth(unsigned int,unsigned int): Sets the line width.

Constructor and Destructor

o CATVisPropertiesValues

public CATVisPropertiesValues(

)

Constructs a graphic property set.

Methods

o GetColor

public GetColor(		`oRed`,
		`oGreen`,
		`oBlue`)

Retrieves the color.

Parameters:

oRed: A value between 0 and 255.
oGreen: A value between 0 and 255.
oBlue: A value between 0 and 255.

Returns:

Legal value:

S_OK: The color has been defined using the method.
E_FAIL: The color has not been defined using the method or the color has been reset using the method.

o GetInheritance

public GetInheritance(		`iType`,
		`oInheritance`)

Retrieves the inheritance flag for a given property.

Parameters:

iType

The type of property. The legal values> are:Color,Opacity,Line Type,Line Width.

oInheritance

The flag of inheritance for the iType property.
Legal value:

0: No heritance
1: Heritance

Returns:

Legal value:

S_OK: The inheritance flag has been defined using the Setxxx method.
E_FAIL: The inheritance flag has not been defined using the the Setxxx method or the inheritance flag has been reset using the method.

o GetLayer

public GetLayer( oLayer)

Retrieves the layer number.

Parameters:

oLayer: The layer number between 0 and 999

Returns:

Legal value:

S_OK: The layer value has been defined using the method.
E_FAIL: The layer value has not been defined using the method or the layer value has been reset using the method.

o GetLineType

public GetLineType( oLineType)

Retrieves the line type.

Parameters:

oLineType: The value ranges from 1 to 63. Each index is a line type customizable in the page Tools/Options/General/Display/Line Type.

Returns:

Legal value:

S_OK: The line type has been defined using the method.
E_FAIL: The line type has not been defined using the method or the line type has been reset using the method.

o GetOpacity

public GetOpacity( oOpacity)

Retrieves the opacity value.

Parameters:

oOpacity: A value between 0 and 255.

Returns:

Legal value:

S_OK: The opacity has been defined using the method.
E_FAIL: The opacity has not been defined using the method or the opacity has been reset using the method.

o GetPickAttr

public GetPickAttr( oPick)

Retrieves the pick flag.

Parameters:

oPick: The pick flag

Returns:

Legal value:

S_OK: The pick flag has been defined using the method.
E_FAIL: The pick flag has not been defined using the method or the pick flag has been reset using the method.

o GetShowAttr

public GetShowAttr( oShow)

Retrieves the show flag.

Parameters:

oShow: The show flag

Returns:

Legal value:

S_OK: The show flag has been defined using the method.
E_FAIL: The show flag has not been defined using the method or the show flag has been reset using the method.

o GetSymbolType

public GetSymbolType( oSymbol)

Retrieves the point symbol.

Parameters:

oSymbol

The point symbol.
see the

Returns:

Legal value:

S_OK: The symbol has been defined using the method.
E_FAIL: The symbol has not been defined using the method or the symbol has been reset using the method.

o GetWidth

public GetWidth( oWidth)

Retrieves the line width.

Parameters:

oWidth: The value ranges from 1 to 63. Each index is a thickness customizable in the Tools/Options/General/Display/thickness property page.

Returns:

Legal value:

S_OK: The line width has been defined using the method.
E_FAIL: The line width has not been defined using the method or the line width has been reset using the method.

o ResetColor

public ResetColor(

)

Resets the color. The color becomes undefined.

Returns:

Legal value:

S_OK

o ResetInheritance

public ResetInheritance(

)

Resets all inheritance flags. All inheritance flags become undefined.

Returns:

Legal value:

S_OK

o ResetLayer

public ResetLayer(

)

Resets the layer value. The layer value becomes undefined.

Returns:

Legal value:

S_OK

o ResetLineType

public ResetLineType(

)

Resets the line type. The line type becomes undefined.

Returns:

Legal value:

S_OK

o ResetOpacity

public ResetOpacity(

)

Resets the opacity value. The opacity becomes undefined.

Returns:

Legal value:

S_OK

o ResetPickAttr

public ResetPickAttr(

)

Resets the pick flag. The pick flag becomes undefined

Returns:

Legal value:

S_OK

o ResetShowAttr

public ResetShowAttr(

)

Resets the show flag. The show flag becomes undefined

Returns:

Legal value:

S_OK

o ResetSymbolType

public ResetSymbolType(

)

Resets the point symbol. The symbol becomes undefined.

Returns:

Legal value:

S_OK

o ResetWidth

public ResetWidth(

)

Resets the line width. The line width becomes undefined.

Returns:

Legal value:

S_OK

o SetColor

public SetColor(	`iRed`,
	`iGreen`,
	`iBlue`,
	`iInheritance`	`=0`)

Sets the color.

Parameters:

iRed

A value between 0 and 255.

iGreen

A value between 0 and 255.

iBlue

A value between 0 and 255.

iInheritance

Legal value:

0: No heritance
1: Heritance

Returns:

Legal value:

S_OK

o SetInheritance

public SetInheritance(		`iType`,
		`iInheritance`)

Sets the inheritance flag for a given property.

Parameters:

iType

The type of property. The legal values> are:Color,Opacity,Line Type,Line Width.

oInheritance

The inheritance flag for the iType property.
Legal value:

0: No heritance
1: Heritance

Returns:

Legal value:

S_OK: iType is valid
E_FAIL: iType is not valid.

o SetLayer

public SetLayer( iLayer)

Sets the layer number.

Parameters:

iLayer: The layer number between 0 and 999

Returns:

Legal value:

S_OK

o SetLineType

public SetLineType(		`iLineType`,
		`iInheritance`	`=0`)

Sets the line type.

Parameters:

iLineType

The value ranges from 1 to 63. Each index is a line type customizable in the Tools/Options/General/Display/Line Type property page.

iInheritance

Legal value:

0: No heritance
1: Heritance

Returns:

Legal value:

S_OK

o SetOpacity

public SetOpacity(		`iOpacity`,
		`iInheritance`	`=0`)

Sets the opacity value.

Parameters:

iOpacity

The opacity is defined from 255 (total opacity) to 0 (total transparency).
In Material visualization mode the transparency is real, so the element is truly more or less opaque. But in any other visualization mode, the transparency is a simulation, so if the opacity is between 0 and 254, the element is transparent and displayed in the same way whatever the opacity value, and if the opacity is 255 the element is opaque.

iInheritance

Legal value:

0: No heritance for the opacity

Returns:

Legal value:

S_OK

o SetPickAttr

public SetPickAttr( iPick)

Sets the pick flag.

Parameters:

iPick: The pick flag

Returns:

Legal value:

S_OK

o SetShowAttr

public SetShowAttr( iShow)

Sets the show flag.

Parameters:

iShow: The show flag

Returns:

Legal value:

S_OK

o SetSymbolType

public SetSymbolType( iSymbol)

Sets the point symbol.

Parameters:

iSymbol

The point symbol.
legal values:

CROSS: a cross which looks like a "X".
PLUS: a cross which looks like a "+"
CONCENTRIC: an unfilled circle
COINCIDENT: two unfilled concentric circles
FULLCIRCLE: a filled circle
FULLSQUARE: a filled square
STAR: a star which is the union of a 2D marker CROSS, a 2D marker PLUS and a 2D marker DOT
DOT: a dot
SMALLDOT: a smalldot whose size is one pixel
MISC1: a kind of arrow which points to the bottom-left
```
	     /
	|  /
	|/__
	
```
MISC2: a kind of arrow which points to the top-rigth
```
	    ___ 	
	      /| 
	    /  |
	  /
	
```
FULLCIRCLE2: a big FULLCIRCLE
FULLSQUARE2: a big FULLSQUARE

Returns:

Legal value:

S_OK

o SetWidth

public SetWidth(		`iWidth`,
		`iInheritance`	`=0`)

Sets the line width.

Parameters:

iWidth

The value ranges from 1 to 63. Each index is a thickness customizable in the Tools/Options/General/Display/thickness property page.

iInheritance

Legal value:

0: No heritance
1: Heritance

Returns:

Legal value:

S_OK

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

VisualizationInterfaces writeClassCharacteristic(); CATVisPropertiesValues

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

VisualizationInterfaces CATVisPropertiesValues