VISU.ScalarMap Interface Reference

Interface of the Scalar Map. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.ScalarMap:

Public Types
enum	Orientation { HORIZONTAL, VERTICAL }
Public Member Functions
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 is responsable for coloring of 3D field presentations according the scalar values applied to different cells. As well it contains presentation parameters of the scalar bar. The scalar bar is displayed along with each colored field presentation and serves for consulting the correspondance between colors and data values.

---

Member Enumeration Documentation

enum VISU::ScalarMap::Orientation

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

void VISU.ScalarMap.SetScalarMode (  in long  theScalarMode  )

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

long VISU.ScalarMap.GetScalarMode (   )

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

void VISU.ScalarMap.SetScaling (  in Scaling  theScaling  )

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 (   )

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

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

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 (   )

Gets the min boundary of the scalar bar.

double VISU.ScalarMap.GetMax (   )

Gets the max boundary of the scalar bar.

void VISU.ScalarMap.SetBarOrientation (  in Orientation  theOrientation  )

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 (   )

Gets the type of orientation of the scalar bar.

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

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 (   )

Gets horizontal position of the scalar bar origin.

double VISU.ScalarMap.GetPosY (   )

Gets vertical position of the scalar bar origin.

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

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 (   )

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

double VISU.ScalarMap.GetHeight (   )

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  )

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 (   )

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  )

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 (   )

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  )

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 (   )

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

---