SALOME documentation central

VISU.PointMap3d Interface Reference

PointMap3d representation interface More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.PointMap3d:
Inheritance graph

Public Types

enum  Orientation { HORIZONTAL, VERTICAL }
enum  Orientation { HORIZONTAL, VERTIACAL }

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 ()
void SetScaling (in Scaling theScaling)
Scaling GetScaling ()
void SetScaleFactor (in double theScaleFactor)
double GetScaleFactor ()
void SetContourPrs (in boolean theIsContourPrs)
boolean GetIsContourPrs ()
void SetNbOfContours (in long theNb)
long GetNbOfContours ()
void SetTitle (in string theTitle)
string GetTitle ()
void SetOrientation (in Orientation theOrientation)
Orientation GetOrientation ()
long GetNbRows ()
long GetNbColumns ()

Detailed Description

Presentation parameters of the Table Point Map in 3d view.


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.

enum VISU::Table::Orientation [inherited]

This enumeration contains a set of elements defining the orientation of the table.

Enumerator:
HORIZONTAL 

Horizontal orientation of the table.

VERTIACAL 

Vertical orientation of the table.


Member Function Documentation

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.

void VISU.Plot3dBase.SetScaleFactor ( in double  theScaleFactor  )  [inherited]

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

Parameters:
theScaleFactor The scaling factor.
double VISU.Plot3dBase.GetScaleFactor (  )  [inherited]

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

void VISU.Plot3dBase.SetContourPrs ( in boolean  theIsContourPrs  )  [inherited]

Sets presentation type: contour or surface.

Parameters:
theIsContourPrs Define, whether presentation type is contour.
boolean VISU.Plot3dBase.GetIsContourPrs (  )  [inherited]

Returns true if presentation type is contour.

void VISU.Plot3dBase.SetNbOfContours ( in long  theNb  )  [inherited]

Sets the number of contours.

Parameters:
theNb The number of contours.
long VISU.Plot3dBase.GetNbOfContours (  )  [inherited]

Gets the number of contours.

void VISU.Table.SetTitle ( in string  theTitle  )  [inherited]

Sets the title of the table.

Parameters:
theTitle String parameter defining the title of this table.
string VISU.Table.GetTitle (  )  [inherited]

Gets the title of the table.

Returns:
A string value containing the title of the table.
void VISU.Table.SetOrientation ( in Orientation  theOrientation  )  [inherited]

Sets orientation of the table.

Parameters:
theOrientation This input parameter defines the orientation of the table. It is taken from the Orientation enumeration.
Orientation VISU.Table.GetOrientation (  )  [inherited]

Gets orientation of the table.

Returns:
Orientation of the table. The returned value will correspond to one of the elements the Orientation enumeration.
long VISU.Table.GetNbRows (  )  [inherited]

Gets the number of rows of the table.

Returns:
Long value corresponding to the number of rows of the table
long VISU.Table.GetNbColumns (  )  [inherited]

Gets the number of columns of the table.

Returns:
Long value corresponding to the number of columns of the table
 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