VISU.StreamLines Interface Reference

Interface of the stream lines representation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.StreamLines:

Public Types
enum	Direction { FORWARD, BACKWARD, BOTH }
enum	Orientation { HORIZONTAL, VERTICAL }
Public Member Functions
boolean	SetParams (in double theIntStep, in double thePropogationTime, in double theStepLength, in Prs3d thePrs3d, in double thePercents, in Direction theDirection)
double	GetIntegrationStep ()
double	GetPropagationTime ()
double	GetStepLength ()
Prs3d	GetSource ()
double	GetUsedPoints ()
Direction	GetDirection ()
void	SetScale (in double theScale)
double	GetScale ()
boolean	IsColored ()
void	ShowColored (in boolean theColored)
SALOMEDS::Color	GetColor ()
void	SetColor (in SALOMEDS::Color theColor)
void	SetScalarMode (in long theScalarMode)
long	GetScalarMode ()
void	SetScaling (in Scaling theScaling)
Scaling	GetScaling ()
void	SetRange (in double theMin, in double theMax)
double	GetMin ()
double	GetMax ()
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
double	GetPosX ()
double	GetPosY ()
void	SetSize (in double theWidth, in double theHeight)
	Size of this presentable object.
double	GetWidth ()
double	GetHeight ()
void	SetNbColors (in long theNbColors)
long	GetNbColors ()
void	SetLabels (in long theNbLabels)
long	GetLabels ()
void	SetTitle (in string theName)
string	GetTitle ()
IdType	GetID ()
VISUType	GetType ()

---

Detailed Description

This interface contains presentation parameters of stream lines presentations.
Stream lines is a type of presentation transforming into lines the cells with vectors having most similar direction. A stream line can be thought of as the path that a massless particle takes in a vector field. Streamlines are used to convey the structure of a vector field. Usually streamlines are created to explore the most interesting features in the field.

---

Member Enumeration Documentation

enum VISU::StreamLines::Direction

This enumerations contains a set of elements necessary for definition of direction of the stream lines. Enumeration values: FORWARD  BACKWARD  BOTH

enum VISU::ScalarMap::Orientation [inherited]

Orientation of the scalar bar. Enumeration values: HORIZONTAL  Horizontal orientation of the scalar bar. VERTICAL  Vertical orientation of the scalar bar. Implemented in VISU.CutPlanes.

---

Member Function Documentation

boolean VISU.StreamLines.SetParams (  in double  theIntStep, in double  thePropogationTime, in double  theStepLength, in Prs3d  thePrs3d, in double  thePercents, in Direction  theDirection )

Sets the parameters of the stream lines presentation. Parameters: theIntStep  Inegration step is a parameter of smoothness of the stream lines. This parameter defines the accuracy of construction of the streamlines. A smaller value of this parameter allows to construct smoother streamlines (at the cost of more computation time). thePropogationTime  This parameter controls the maximum length of the stream line (measured in units of time). theStepLength  This parameter defines the size of the output line segments that make up the streamline (which is represented as a polyline). thePrs3d  The source presentation. The points of the field located on this source presentation will serve as starting points for generation of stream lines. Note: If this parameter is not defined, your stream lines presentation will be generated on all points of the field. Parameters: thePercents  This parameter defines the quantity of points of the field (from 0 to 100%) which will be used as starting points for construction of the stream lines. Thus, the value of this parameter can vary from 0 to 1. theDirection  Direction of the stream lines.(Forward, Backward or Both) Returns: True if all parameters are properly set.

double VISU.StreamLines.GetIntegrationStep (   )

Gets the value of integration step of the stream lines presentation.

double VISU.StreamLines.GetPropagationTime (   )

Gets the value of propagation time of the stream lines presentation.

double VISU.StreamLines.GetStepLength (   )

Gets the value of step length of the stream lines presentation.

Prs3d VISU.StreamLines.GetSource (   )

Returns the source presentation used for generation of the stream lines.

double VISU.StreamLines.GetUsedPoints (   )

Gets the quantity of points of the field used as starting points for generation of the stream lines presentation.

Direction VISU.StreamLines.GetDirection (   )

Returns the direction of the stream lines.

void VISU.DeformedShape.SetScale (  in double  theScale  )  [inherited]

Sets the scale of the presentatable object. Parameters: theScale  Double value defining the scale of this presentable object.

double VISU.DeformedShape.GetScale (   )  [inherited]

Gets the scale of the presentatable object.

boolean VISU.DeformedShape.IsColored (   )  [inherited]

This boolean method returns True if this deformed shape presentation is colored.

void VISU.DeformedShape.ShowColored (  in boolean  theColored  )  [inherited]

Shows this presentation in colored mode. Parameters: theColored  If this boolean parameter is True this presentable object will be shown in colored mode.

SALOMEDS::Color VISU.DeformedShape.GetColor (   )  [inherited]

Gets the color of this presentable object. Returns: The color of this presentable object.

void VISU.DeformedShape.SetColor (  in SALOMEDS::Color  theColor  )  [inherited]

Sets the color of this presentation. Parameters: theColor  The color of this presentation. This parameter is taken from the Color enumeration.

void VISU.ScalarMap.SetScalarMode (  in long  theScalarMode  )  [inherited]

Sets the method of coloring of the elements composing a 3D presentation.

long VISU.ScalarMap.GetScalarMode (   )  [inherited]

Gets the method of coloring of the elements composing a 3D presentation.

void VISU.ScalarMap.SetScaling (  in Scaling  theScaling  )  [inherited]

Sets the type of scaling of the values reflected by the scalar bar. Parameters: theScaling  The value of this parameter is taken from the Scaling enumeration.

Scaling VISU.ScalarMap.GetScaling (   )  [inherited]

Gets the type of scaling of the values reflected by this presentation.

void VISU.ScalarMap.SetRange (  in double  theMin, in double  theMax )  [inherited]

Sets scalar range - min and max boundaries of the scalar bar. Parameters: theMin  Min boundary of the scalar bar. theMax  Max boundary of the scalar bar.

double VISU.ScalarMap.GetMin (   )  [inherited]

Gets the min boundary of the scalar bar.

double VISU.ScalarMap.GetMax (   )  [inherited]

Gets the max boundary of the scalar bar.

void VISU.ScalarMap.SetBarOrientation (  in Orientation  theOrientation  )  [inherited]

Sets the type of orientation of the scalar bar. Parameters: theOrientation  This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

Orientation VISU.ScalarMap.GetBarOrientation (   )  [inherited]

Gets the type of orientation of the scalar bar.

void VISU.ScalarMap.SetPosition (  in double  X, in double  Y )  [inherited]

Sets the position of the scalar bar origin on the screen. Parameters: X  Horizontal position. The value can be between 0 and 1. Y  Vertical position. The value can be between 0 and 1.

double VISU.ScalarMap.GetPosX (   )  [inherited]

Gets horizontal position of the scalar bar origin.

double VISU.ScalarMap.GetPosY (   )  [inherited]

Gets vertical position of the scalar bar origin.

void VISU.ScalarMap.SetSize (  in double  theWidth, in double  theHeight )  [inherited]

Sets the size of the scalar bar. Parameters: theWidth  Width of this presentable object. The value can be between 0 and 1. theHeight  Height of this presentable object. The value can be between 0 and 1.

double VISU.ScalarMap.GetWidth (   )  [inherited]

Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object.

double VISU.ScalarMap.GetHeight (   )  [inherited]

Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object.

void VISU.ScalarMap.SetNbColors (  in long  theNbColors  )  [inherited]

Sets the number of colors which will be used for presentation of this presentable object. Parameters: theNbColors  A long value defining the number of colors.

long VISU.ScalarMap.GetNbColors (   )  [inherited]

Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object.

void VISU.ScalarMap.SetLabels (  in long  theNbLabels  )  [inherited]

Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: theNbLabels  A long value defining the number of labels.

long VISU.ScalarMap.GetLabels (   )  [inherited]

Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar.

void VISU.ScalarMap.SetTitle (  in string  theName  )  [inherited]

Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: theName  String parameter defining the name of the scalar bar.

string VISU.ScalarMap.GetTitle (   )  [inherited]

Gets the title of the scalar bar.

IdType VISU.Base.GetID (   )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (   )  [inherited]

Returns the type of the presentable object

---