SALOME documentation central

VISU.ColoredPrs3dBase Interface Reference

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

import "VISU_Gen.idl";

Inheritance diagram for VISU.ColoredPrs3dBase:
Inheritance graph

Public Types

enum  Orientation { HORIZONTAL, VERTICAL }

Public Member Functions

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

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

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.ColoredPrs3dBase.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.ColoredPrs3dBase.GetMin (  ) 

Gets the min boundary of the scalar bar.

double VISU.ColoredPrs3dBase.GetMax (  ) 

Gets the max boundary of the scalar bar.

void VISU.ColoredPrs3dBase.SetSourceRange (  ) 

Sets scalar range that corresponds to the source data.

double VISU.ColoredPrs3dBase.GetSourceMin (  ) 

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

double VISU.ColoredPrs3dBase.GetSourceMax (  ) 

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

boolean VISU.ColoredPrs3dBase.IsRangeFixed (  ) 

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

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

Gets horizontal position of the scalar bar origin.

double VISU.ColoredPrs3dBase.GetPosY (  ) 

Gets vertical position of the scalar bar origin.

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

Gets the width of this presentable object.

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

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  ) 

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

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  ) 

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

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  ) 

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

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