VISU.ColoredPrs3d Interface Reference

Basic Interface for the Colored 3D Presentations. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.ColoredPrs3d:

Public Member Functions
void	SetScalarMode (in long theScalarMode)
long	GetScalarMode ()
double	GetMin ()
double	GetMax ()
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 ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
void	RemoveFromStudy ()
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 Function Documentation

void VISU.ColoredPrs3d.SetScalarMode (  in long  theScalarMode  )

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

long VISU.ColoredPrs3d.GetScalarMode (   )

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

double VISU.ColoredPrs3d.GetMin (   )

Gets the min boundary of the scalar bar.

double VISU.ColoredPrs3d.GetMax (   )

Gets the max boundary of the scalar bar.

void VISU.ColoredPrs3d.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.ColoredPrs3d.GetPosX (   )

Gets horizontal position of the scalar bar origin.

double VISU.ColoredPrs3d.GetPosY (   )

Gets vertical position of the scalar bar origin.

void VISU.ColoredPrs3d.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.ColoredPrs3d.GetWidth (   )

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

double VISU.ColoredPrs3d.GetHeight (   )

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

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

Gets the title of the scalar bar.

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

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

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

Generated on Tue Sep 19 10:13:15 2006 for SALOME - VISU - v.3.2.2 by  1.4.6