SALOME documentation central

VISU.GaussPoints Interface Reference

Gauss Points presentation interface. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.GaussPoints:
Inheritance graph

Public Types

enum  PrimitiveType { SPRITE, POINT, SPHERE }
enum  Orientation { HORIZONTAL, VERTICAL }

Public Member Functions

void SetIsActiveLocalScalarBar (in boolean theFlag)
 Set flag indicating which scalar bar is active.
boolean GetIsActiveLocalScalarBar ()
 Get flag indicating which scalar bar is active.
void SetIsDispGlobalScalarBar (in boolean theFlag)
 Set flag indicating visibility of global scalar bar.
boolean GetIsDispGlobalScalarBar ()
 Get flag indicating visibility of global scalar bar.
void SetSpacing (in double theSpacing)
 Set value of the distance between global and local scalar bars.
double GetSpacing ()
 Get value of the distance between global and local scalar bars.
boolean IsBarVisible ()
void SetBarVisible (in boolean theVisible)
void SetIsColored (in boolean theIsColored)
boolean GetIsColored ()
 Gets current color mode.
void SetColor (in SALOMEDS::Color theColor)
void SetBiColor (in boolean theIsBiColor)
boolean GetBiColor ()
 Get the Bicolor mode.
boolean GetIsDeformed ()
 Checks whether the Gauss Points will be deformed or not.
void SetIsDeformed (in boolean theIsDeformed)
 Apply deformation on the Gauss Points.
void SetScaleFactor (in double theScaleFactor)
double GetScaleFactor ()
void SetPrimitiveType (in PrimitiveType thePrimitiveType)
 Set type of the primitives which is used for drawing the Gauss Points.
PrimitiveType GetPrimitiveType ()
 Get type of the primitives which is used for drawing the Gauss Points.
void SetClamp (in double theClamp)
 Sets Point Sprite clamp.
double GetClamp ()
 Gets Point Sprite clamp.
void SetMinSize (in double theMinSize)
 Sets minimum size of Point Sprites.
double GetMinSize ()
 Gets minimum size of Point Sprites.
void SetMaxSize (in double theMaxSize)
 Sets maximum size of Point Sprites.
double GetMaxSize ()
 Gets maximum size of Point Sprites.
void SetMagnification (in double theMagnification)
 Sets magnification for Point Sprites.
double GetMagnification ()
 Gets magnification for Point Sprites.
void SetMagnificationIncrement (in double theIncrement)
 Sets the increment of changing Magnification parameter.
double GetMagnificationIncrement ()
 Gets the increment of changing Magnification parameter.
void SetGeomSize (in double theGeomSize)
 Sets Point Sprites size.
double GetGeomSize ()
 Sets size of Point Sprite.
string GetMainTexture ()
 Get path to the image using for Main Point Sprite texture.
string GetAlphaTexture ()
 Get path to the image using for Alpha Point Sprite texture.
void SetTextures (in string theMainTexture, in string theAlphaTexture)
 Points Main and AlphaMask images to be used by Point Sprites.
void SetAlphaThreshold (in double theAlphaThreshold)
 Sets Point Sprite Alpha threshold.
double GetAlphaThreshold ()
 Gets Point Sprite Alpha threshold.
void SetResolution (in long theResolution)
 Sets resolution of the Geometrical Sphere.
long GetResolution ()
 Sets resolution of the Geometrical Sphere.
void SetFaceLimit (in long theFaceLimit)
 Sets how many faces of can be drawn in the Geometrical Sphere primitive mode.
long GetFaceLimit ()
 Defines how many faces of can be drawn in the Geometrical Sphere primitive mode.
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 ()

Detailed Description

Presentation parameters of the Gauss Points presentation.


Member Enumeration Documentation

This enumeration contains a set of elements defining the type of representation of the vector head.

Enumerator:
SPRITE 
POINT 
SPHERE 

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

void VISU.GaussPoints.SetIsActiveLocalScalarBar ( in boolean  theFlag  ) 
boolean VISU.GaussPoints.GetIsActiveLocalScalarBar (  ) 
void VISU.GaussPoints.SetIsDispGlobalScalarBar ( in boolean  theFlag  ) 
boolean VISU.GaussPoints.GetIsDispGlobalScalarBar (  ) 
void VISU.GaussPoints.SetSpacing ( in double  theSpacing  ) 
double VISU.GaussPoints.GetSpacing (  ) 
boolean VISU.GaussPoints.IsBarVisible (  ) 

Returns visibility state of scalar bar

void VISU.GaussPoints.SetBarVisible ( in boolean  theVisible  ) 

Sets visibility state of scalar bar

void VISU.GaussPoints.SetIsColored ( in boolean  theIsColored  ) 

Set the Multicolored mode.

Parameters:
theIsColored is used to switch between Results and Geometry modes. Multiple colors are using when the presentation is drawing in the Results mode, one color - in the Geometry mode.
boolean VISU.GaussPoints.GetIsColored (  ) 
void VISU.GaussPoints.SetColor ( in SALOMEDS::Color  theColor  ) 

Sets the color of this presentation in case of IsColored switched off.

Parameters:
theColor The color of this presentation. This parameter is taken from the Color enumeration.
void VISU.GaussPoints.SetBiColor ( in boolean  theIsBiColor  ) 

When the Bicolor parameter is set to true, scalar bars are drawing with two colors : red color correspoonds to positive scalar values, blue color - to negative values.

boolean VISU.GaussPoints.GetBiColor (  ) 
boolean VISU.GaussPoints.GetIsDeformed (  ) 
void VISU.GaussPoints.SetIsDeformed ( in boolean  theIsDeformed  ) 
void VISU.GaussPoints.SetScaleFactor ( in double  theScaleFactor  ) 

Sets the scale factor for scalar values (how much corresponding mesh elements should be translated).

Parameters:
theScaleFactor The scaling factor.
double VISU.GaussPoints.GetScaleFactor (  ) 

Gets the scale factor for scalar values. (how much corresponding mesh elements is translated)

void VISU.GaussPoints.SetPrimitiveType ( in PrimitiveType  thePrimitiveType  ) 
PrimitiveType VISU.GaussPoints.GetPrimitiveType (  ) 
void VISU.GaussPoints.SetClamp ( in double  theClamp  ) 
double VISU.GaussPoints.GetClamp (  ) 
void VISU.GaussPoints.SetMinSize ( in double  theMinSize  ) 
double VISU.GaussPoints.GetMinSize (  ) 
void VISU.GaussPoints.SetMaxSize ( in double  theMaxSize  ) 
double VISU.GaussPoints.GetMaxSize (  ) 
void VISU.GaussPoints.SetMagnification ( in double  theMagnification  ) 
double VISU.GaussPoints.GetMagnification (  ) 
void VISU.GaussPoints.SetMagnificationIncrement ( in double  theIncrement  ) 
double VISU.GaussPoints.GetMagnificationIncrement (  ) 
void VISU.GaussPoints.SetGeomSize ( in double  theGeomSize  ) 
double VISU.GaussPoints.GetGeomSize (  ) 
string VISU.GaussPoints.GetMainTexture (  ) 
string VISU.GaussPoints.GetAlphaTexture (  ) 
void VISU.GaussPoints.SetTextures ( in string  theMainTexture,
in string  theAlphaTexture 
)
void VISU.GaussPoints.SetAlphaThreshold ( in double  theAlphaThreshold  ) 
double VISU.GaussPoints.GetAlphaThreshold (  ) 
void VISU.GaussPoints.SetResolution ( in long  theResolution  ) 
long VISU.GaussPoints.GetResolution (  ) 
void VISU.GaussPoints.SetFaceLimit ( in long  theFaceLimit  ) 
long VISU.GaussPoints.GetFaceLimit (  ) 
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

 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