VISU.IsoSurfaces Interface Reference

Interface of the isometric surface presentation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.IsoSurfaces:

Public Types
	HORIZONTAL
	VERTICAL
enum	Orientation { HORIZONTAL, VERTICAL }
Public Member Functions
void	SetNbSurfaces (in long theNb)
long	GetNbSurfaces ()
void	SetScaling (in Scaling theScaling)
Scaling	GetScaling ()
void	SetRange (in double theMin, in double theMax)
void	SetSourceRange ()
void	AddMeshOnGroup (in string theGroupName)
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
long	GetScalarMode ()
double	GetMin ()
double	GetMax ()
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	SetTitle (in string theName)
string	GetTitle ()
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 contains presentation parameters of isometric surface presentations.
Iso surfaces presentation combines all equal scalar values on the cells and on the basis of them constructs isobaric surfaces, which form this presentation.

---

Member Enumeration Documentation

enum VISU::ColoredPrs3d::Orientation [inherited]

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.IsoSurfaces.SetNbSurfaces

(

in long

theNb

)

Sets the number of isometric surfaces.

Parameters:

theNb

A long value defining the number of isometric surfaces which will be used for construction of this presentation.

long VISU.IsoSurfaces.GetNbSurfaces

(

)

Gets the number of isometric surfaces

void VISU.ScalarMap.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.ScalarMap.GetScaling

(

)

[inherited]

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

void VISU.ScalarMap.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.

void VISU.ScalarMap.SetSourceRange

(

)

[inherited]

Sets scalar range that corresponds to the source data.

void VISU.ScalarMap.AddMeshOnGroup

(

in string

theGroupName

)

[inherited]

Add group as geometry of presentation.

Parameters:

	theMeshName	- mesh name
	theGroupName	- group name

void VISU.ScalarMap.RemoveAllGeom

(

)

[inherited]

PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh).

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.

double VISU.ColoredPrs3d.GetMin

(

)

[inherited]

Gets the min boundary of the scalar bar.

double VISU.ColoredPrs3d.GetMax

(

)

[inherited]

Gets the max boundary of the scalar bar.

double VISU.ColoredPrs3d.GetSourceMin

(

)

[inherited]

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

double VISU.ColoredPrs3d.GetSourceMax

(

)

[inherited]

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

boolean VISU.ColoredPrs3d.IsRangeFixed

(

)

[inherited]

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

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

(

)

[inherited]

Gets horizontal position of the scalar bar origin.

double VISU.ColoredPrs3d.GetPosY

(

)

[inherited]

Gets vertical position of the scalar bar origin.

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

(

)

[inherited]

Gets the width of this presentable object.

Returns:

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

double VISU.ColoredPrs3d.GetHeight

(

)

[inherited]

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

)

[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.ColoredPrs3d.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.ColoredPrs3d.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.ColoredPrs3d.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.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.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.ColoredPrs3d.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

Generated on Thu Jun 21 14:31:12 2007 for SALOME - VISU - v.4.0.0 by  1.4.7