VISU.Curve Interface Reference

Interface of curve representation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.Curve:

Public Types
enum	MarkerType {   NONE, CIRCLE, RECTANGLE, DIAMOND,   DTRIANGLE, UTRIANGLE, LTRIANGLE, RTRIANGLE,   CROSS, XCROSS }
enum	LineType {   VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE,   DASHDOTLINE, DASHDOTDOTLINE }
Public Member Functions
void	SetTitle (in string theTitle)
string	GetTitle ()
void	SetColor (in SALOMEDS::Color theColor)
SALOMEDS::Color	GetColor ()
void	SetMarker (in MarkerType theType)
MarkerType	GetMarker ()
void	SetLine (in LineType theType, in long theLineWidth)
LineType	GetLine ()
long	GetLineWidth ()
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()

---

Detailed Description

Manages presentation parameters of one curve. It can be used for presentation of a set of curves using a combined presentation.

---

Member Enumeration Documentation

enum VISU::Curve::MarkerType

This enumeration contains a set of elements defining the presentation type of markers (data points) with help of which the curve is constructed on the graphics.

Enumerator:

NONE
CIRCLE
RECTANGLE
DIAMOND
DTRIANGLE
UTRIANGLE
LTRIANGLE
RTRIANGLE
CROSS
XCROSS

enum VISU::Curve::LineType

This enumeration contains a set of elements defining the type of presentation of a curve line on the graphics.

Enumerator:

VOIDLINE
SOLIDLINE
DASHLINE
DOTLINE
DASHDOTLINE
DASHDOTDOTLINE

---

Member Function Documentation

void VISU.Curve.SetTitle

(

in string

theTitle

)

Sets the title of the curve.

Parameters:

theTitle

This string parameter defines the title of this curve.

string VISU.Curve.GetTitle

(

)

Gets the title of the curve.

Returns:

String value corresponding to the title of the curve.

void VISU.Curve.SetColor

(

in SALOMEDS::Color

theColor

)

Sets the color of the curve.

Parameters:

theColor

The color of the curve. This parameter is taken from the Orientation enumeration.

SALOMEDS::Color VISU.Curve.GetColor

(

)

Gets the color of the curve.

Returns:

Color of the curve. The returned value will correspond to one of the elements the Color enumeration.

void VISU.Curve.SetMarker

(

in MarkerType

theType

)

Sets the presentation type of markers (data points) with help of which the curve is constructed on the graphics.

Parameters:

theType

This parameter defines the type of marker with help of which the curve is constructed on the graphics. It is taken from MarkerType enumeration.

MarkerType VISU.Curve.GetMarker

(

)

Gets the presentation type of markers (data points) with help of which the curve is constructed on the graphics.

Returns:

The type of marker with help of which the curve is constructed on the graphics. The returned value will correspond to one of the elements the MarkerType enumeration.

void VISU.Curve.SetLine	(	in LineType	theType,
		in long	theLineWidth
	)

Sets the type of presentation of curve lines on the graphics.

Parameters:

	theType	This parameter defines the type of presentation of curve lines on the graphics.
	theLineWidth	Long value defining the width of the curve line.

LineType VISU.Curve.GetLine

(

)

Gets the type of representation of curve lines on the graphics.

Returns:

The type of representation of curve lines on the graphics.

long VISU.Curve.GetLineWidth

(

)

Gets the width of the curve line.

Returns:

Long value corresponding to the width of the curve line.

void VISU.RemovableObject.RemoveFromStudy

(

)

[inherited]

Remove object from study.

IdType VISU.Base.GetID

(

)

[inherited]

Returns ID of the object.

VISUType VISU.Base.GetType

(

)

[inherited]

Returns the type of the presentable object