SALOME documentation central

VISU.StreamLines Interface Reference

Interface of the stream lines representation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.StreamLines:
Inheritance graph

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 ()
boolean IsColored ()
void ShowColored (in boolean theColored)
SALOMEDS::Color GetColor ()
void SetColor (in SALOMEDS::Color theColor)
boolean IsBarVisible ()
void SetBarVisible (in boolean theVisible)
void SetGaussMetric (in GaussMetric theGaussMetric)
GaussMetric GetGaussMetric ()
void SetLinkColor (in SALOMEDS::Color theColor)
SALOMEDS::Color GetLinkColor ()
void SetTitle (in string theName)
string GetTitle ()
void SetScalarMode (in long theScalarMode)
long GetScalarMode ()
void SetIsDistributionVisible (in boolean theIs)
boolean GetIsDistributionVisible ()
 Gets current visibility of a distribution curve.
boolean IsScalarFilterUsed ()
 Gets current filtering by scalars mode.
void UseScalarFiltering (in boolean theUseScalarFilter)
void SetScalarFilterRange (in double theMin, in double theMax)
double GetScalarFilterMin ()
double GetScalarFilterMax ()
void AddMeshOnGroup (in string theGroupName)
void RemoveAllGeom ()
void SetRange (in double theMin, in double theMax)
double GetMin ()
double GetMax ()
void SetSourceRange ()
double GetSourceMin ()
double GetSourceMax ()
boolean IsRangeFixed ()
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 SetBarOrientation (in Orientation theOrientation)
Orientation GetBarOrientation ()
void SetOffset (in float theDx, in float theDy, in float theDz)
void GetOffset (out float theDx, out float theDy, out float theDz)
float GetMemorySize ()
void RemoveFromStudy ()
IdType GetID ()
VISUType GetType ()
void SetScaling (in Scaling theScaling)
Scaling GetScaling ()

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

This enumerations contains a set of elements necessary for definition of direction of the stream lines.

Enumerator:
FORWARD 
BACKWARD 
BOTH 

Orientation of the scalar bar (to provide backward compatibility).

Enumerator:
HORIZONTAL 

Horizontal orientation of the scalar bar.

VERTICAL 

Vertical orientation of the scalar bar.

Implemented in VISU.Plot3D, and 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.

boolean VISU.MonoColorPrs.IsColored (  )  [inherited]

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

void VISU.MonoColorPrs.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.MonoColorPrs.GetColor (  )  [inherited]

Gets the color of this presentable object.

Returns:
The color of this presentable object.
void VISU.MonoColorPrs.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.
boolean VISU.ScalarMap.IsBarVisible (  )  [inherited]

Returns visibility state of scalar bar

void VISU.ScalarMap.SetBarVisible ( in boolean  theVisible  )  [inherited]

Sets visibility state of scalar bar

void VISU.ScalarMap.SetGaussMetric ( in GaussMetric  theGaussMetric  )  [inherited]

Sets the gauss metric for the presentation.

Parameters:
theGaussMetric The value of this parameter is taken from the GaussMetric enumeration.
GaussMetric VISU.ScalarMap.GetGaussMetric (  )  [inherited]

Gets the gauss metric of the presentation.

void VISU.ScalarMap.SetLinkColor ( in SALOMEDS::Color  theColor  )  [inherited]

Sets the color of mesh links.

Parameters:
theColor The color of the links. This parameter is taken from Color enumeration.
SALOMEDS::Color VISU.ScalarMap.GetLinkColor (  )  [inherited]

Gets the color of mesh links.

void VISU.ColoredPrs3d.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.ColoredPrs3d.GetTitle (  )  [inherited]

Gets the title of the scalar bar.

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

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

long VISU.ColoredPrs3d.GetScalarMode (  )  [inherited]

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

void VISU.ColoredPrs3d.SetIsDistributionVisible ( in boolean  theIs  )  [inherited]

Set the visibility of a distribution curve.

Parameters:
theIs is used to switch on/off the visibility of a distribution curve.
boolean VISU.ColoredPrs3d.GetIsDistributionVisible (  )  [inherited]
boolean VISU.ColoredPrs3d.IsScalarFilterUsed (  )  [inherited]
void VISU.ColoredPrs3d.UseScalarFiltering ( in boolean  theUseScalarFilter  )  [inherited]
void VISU.ColoredPrs3d.SetScalarFilterRange ( 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.
theIsFilter if true then filter by scalars.
double VISU.ColoredPrs3d.GetScalarFilterMin (  )  [inherited]
double VISU.ColoredPrs3d.GetScalarFilterMax (  )  [inherited]
void VISU.ColoredPrs3d.AddMeshOnGroup ( in string  theGroupName  )  [inherited]

Add group as geometry of presentation.

Parameters:
theMeshName - mesh name
theGroupName - group name
void VISU.ColoredPrs3d.RemoveAllGeom (  )  [inherited]

PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh).

void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.GetMin (  )  [inherited]

Gets the min boundary of the scalar bar.

double VISU.ColoredPrs3dBase.GetMax (  )  [inherited]

Gets the max boundary of the scalar bar.

void VISU.ColoredPrs3dBase.SetSourceRange (  )  [inherited]

Sets scalar range that corresponds to the source data.

double VISU.ColoredPrs3dBase.GetSourceMin (  )  [inherited]

Gets the min boundary of the scalar bar from source data.

double VISU.ColoredPrs3dBase.GetSourceMax (  )  [inherited]

Gets the max boundary of the scalar bar from source data.

boolean VISU.ColoredPrs3dBase.IsRangeFixed (  )  [inherited]

Defines whether the scalar range corresponds to the source data or not.

void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.GetPosX (  )  [inherited]

Gets horizontal position of the scalar bar origin.

double VISU.ColoredPrs3dBase.GetPosY (  )  [inherited]

Gets vertical position of the scalar bar origin.

void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.GetWidth (  )  [inherited]

Gets the width of this presentable object.

Returns:
A double value corresponding to the width of this presentable object.
double VISU.ColoredPrs3dBase.GetHeight (  )  [inherited]

Gets the height of this presentable object.

Returns:
A double value corresponding to the height of this presentable object.
void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.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.ColoredPrs3dBase.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.ColoredPrs3dBase.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.ColoredPrs3dBase.SetBarOrientation ( in Orientation  theOrientation  )  [inherited]

Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:
theOrientation This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
Orientation VISU.ColoredPrs3dBase.GetBarOrientation (  )  [inherited]

Gets the type of orientation of the scalar bar (to provide backward compatibility).

void VISU.Prs3d.SetOffset ( in float  theDx,
in float  theDy,
in float  theDz 
) [inherited]

Move the 3D presentation according to the given offset parameters

void VISU.Prs3d.GetOffset ( out float  theDx,
out float  theDy,
out float  theDz 
) [inherited]

Gets offset parameters for the 3D presentation

float VISU.Prs3d.GetMemorySize (  )  [inherited]

Gets memory size actually used by the presentation (Mb).

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

void VISU.ScaledPrs3d.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.ScaledPrs3d.GetScaling (  )  [inherited]

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

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator

Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS