VISU.VISU_Gen Interface Reference

VISU_Gen interface More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.VISU_Gen:

Public Member Functions
void	SetCurrentStudy (in SALOMEDS::Study theStudy)
SALOMEDS::Study	GetCurrentStudy ()
ViewManager	GetViewManager ()
SALOMEDS::SObject	ImportTables (in string theFileName, in boolean theFirstStrAsTitle)
boolean	ExportTableToFile (in SALOMEDS::SObject theTable, in string theFileName)
Result	ImportFile (in string theFileName)
Result	CreateResult (in string theFileName)
Result	CopyAndImportFile (in string theFileName)
Result	ImportMed (in SALOMEDS::SObject theMedSObject)
Result	ImportMedField (in SALOME_MED::FIELD theField)
void	RenameEntityInStudy (in Result theResult, in string theMeshName, in Entity theEntity, in string theNewName)
void	RenameFamilyInStudy (in Result theResult, in string theMeshName, in Entity theEntity, in string theSubMeshName, in string theNewName)
void	RenameGroupInStudy (in Result theResult, in string theMeshName, in string theSubMeshName, in string theNewName)
Mesh	MeshOnEntity (in Result theResult, in string theMeshName, in Entity theEntity)
Mesh	FamilyMeshOnEntity (in Result theResult, in string theMeshName, in Entity theEntity, in string theFamilyName)
Mesh	GroupMesh (in Result theResult, in string theMeshName, in string theGroupName)
ScalarMap	ScalarMapOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
GaussPoints	GaussPointsOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
DeformedShape	DeformedShapeOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
DeformedShapeAndScalarMap	ScalarMapOnDeformedShapeOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
DeformedShapeAndScalarMap	DeformedShapeAndScalarMapOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
Vectors	VectorsOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
IsoSurfaces	IsoSurfacesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
StreamLines	StreamLinesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
CutPlanes	CutPlanesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
CutLines	CutLinesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
CutSegment	CutSegmentOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
Plot3D	Plot3DOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theTimeStampNumber)
Table	CreateTable (in string theTableEntry)
Curve	CreateCurve (in Table theTable, in long theHRow, in long theVRow)
Curve	CreateCurveWithZ (in Table theTable, in long theHRow, in long theVRow, in long theZRow)
Curve	CreateCurveWithZExt (in Table theTable, in long theHRow, in long theVRow, in long theZRow, in boolean theIsV2)
Container	CreateContainer ()
Animation	CreateAnimation (in View3D theView3d)
Evolution	CreateEvolution (in XYPlot theXYPlot)
void	DeleteResult (in Result theResult)
void	DeletePrs3d (in Prs3d thePrs3d)
ColoredPrs3dCache	GetColoredPrs3dCache (in SALOMEDS::Study theStudy)
long	CreateClippingPlane (in double X, in double Y, in double Z, in double dX, in double dY, in double dZ, in boolean auto, in string name)
void	EditClippingPlane (in long id, in double X, in double Y, in double Z, in double dX, in double dY, in double dZ, in boolean auto, in string name)
ClippingPlane	GetClippingPlane (in long id)
boolean	DeleteClippingPlane (in long id)
boolean	ApplyClippingPlane (in Prs3d thePrs, in long id)
boolean	DetachClippingPlane (in Prs3d thePrs, in long id)
long	GetClippingPlanesNb ()
boolean	VTK2MED (in string_array theVTKFiles, in string theMEDFile, in string theMeshName, in double_array theTStamps)
long	LoadTexture (in string theTextureFile)
IdType	GetID ()
VISUType	GetType ()

---

Detailed Description

This is the main interface of VISU component. It is necessary for creation of post-processing presentations from given Result and Table object reference, using the views provided by ViewManager.

---

Member Function Documentation

void VISU.VISU_Gen.SetCurrentStudy

(

in SALOMEDS::Study

theStudy

)

Sets a definite study to be current.

SALOMEDS::Study VISU.VISU_Gen.GetCurrentStudy

(

)

Gets the current study.

ViewManager VISU.VISU_Gen.GetViewManager

(

)

Gets the View Manager which is used for creation of post-processing presentations.

SALOMEDS::SObject VISU.VISU_Gen.ImportTables	(	in string	theFileName,
		in boolean	theFirstStrAsTitle
	)

Imports tables from a file and create TableAttribute in Study

boolean VISU.VISU_Gen.ExportTableToFile	(	in SALOMEDS::SObject	theTable,
		in string	theFileName
	)

Export table to a file

Result VISU.VISU_Gen.ImportFile

(

in string

theFileName

)

Imports data from a file. The access to this file will be conserved outside of the application.

Parameters:

theFileName

String parameter defining the name of the file from which the data will be imported.

Result VISU.VISU_Gen.CreateResult

(

in string

theFileName

)

Create result and initialize its with the file. The access to this file will be conserved outside of the application.

Parameters:

theFileName

String parameter defining the name of the file from which the data will be imported.

Result VISU.VISU_Gen.CopyAndImportFile

(

in string

theFileName

)

Imports data from a file. The access to this file will closed.

Parameters:

theFileName

String parameter defining the name of the file from which the data will be imported.

Result VISU.VISU_Gen.ImportMed

(

in SALOMEDS::SObject

theMedSObject

)

Imports data from a MED object.

Result VISU.VISU_Gen.ImportMedField

(

in SALOME_MED::FIELD

theField

)

Imports data from a MED field.

void VISU.VISU_Gen.RenameEntityInStudy	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theNewName
	)

Rename a study object, representing a mesh, specified by given values.

Parameters:

theResult	Data generated in other sources (MED object or file).
theMeshName	One of the meshes presented in MED file.
theEntity	Type of entity where the field is defined.
theSubMeshName	Name of sub-mesh (group or family).
theNewName	Name to be given to the study object.

void VISU.VISU_Gen.RenameFamilyInStudy	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theSubMeshName,
		in string	theNewName
	)

void VISU.VISU_Gen.RenameGroupInStudy	(	in Result	theResult,
		in string	theMeshName,
		in string	theSubMeshName,
		in string	theNewName
	)

Mesh VISU.VISU_Gen.MeshOnEntity	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity
	)

Creates a mesh on the basis of the data generated in other sources (MED object or file).

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined

Mesh VISU.VISU_Gen.FamilyMeshOnEntity	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFamilyName
	)

Creates on the basis of a family a mesh which will be composed of geometrical elements, corresponding to the type of cells (node, edge, face or cell) of this family.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined.

Mesh VISU.VISU_Gen.GroupMesh	(	in Result	theResult,
		in string	theMeshName,
		in string	theGroupName
	)

Creates a mesh on the basis of a group of families.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theGroupName	Name of the group.

ScalarMap VISU.VISU_Gen.ScalarMapOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a scalar map presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

GaussPoints VISU.VISU_Gen.GaussPointsOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a Gauss Points presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

DeformedShape VISU.VISU_Gen.DeformedShapeOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a deformed shape presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

DeformedShapeAndScalarMap VISU.VISU_Gen.ScalarMapOnDeformedShapeOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a deformed shape presentation. This function is obsolete. Use DeformedShapeAndScalarMapOnField instead.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

DeformedShapeAndScalarMap VISU.VISU_Gen.DeformedShapeAndScalarMapOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a deformed shape presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

Vectors VISU.VISU_Gen.VectorsOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a vector presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

IsoSurfaces VISU.VISU_Gen.IsoSurfacesOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates an iso surface presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

StreamLines VISU.VISU_Gen.StreamLinesOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates an stream lines presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

CutPlanes VISU.VISU_Gen.CutPlanesOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a presentation of cut planes.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

CutLines VISU.VISU_Gen.CutLinesOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a presentation of cut lines.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

CutSegment VISU.VISU_Gen.CutSegmentOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a presentation of cut segment.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

Plot3D VISU.VISU_Gen.Plot3DOnField	(	in Result	theResult,
		in string	theMeshName,
		in Entity	theEntity,
		in string	theFieldName,
		in long	theTimeStampNumber
	)

Creates a Plot3D presentation.

Parameters:

theResult	Data generated in other sources. (MED object or file)
theMeshName	One of the meshes presented in MED file
theEntity	Type of entity where the field is defined
theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
theTimeStampNumber	Number of iteration on the field

Table VISU.VISU_Gen.CreateTable

(

in string

theTableEntry

)

Creates a table presentation.

Parameters:

theTableEntry

The entry of the table which will be displayed.

Curve VISU.VISU_Gen.CreateCurve	(	in Table	theTable,
		in long	theHRow,
		in long	theVRow
	)

Creates a curve on the basis of points, whose values are taken from the table.

Parameters:

theTable	Table containing the data for construction of curves.
theHRow	Index of the row in the table: abscissa of the point.
theVRow	Index of the row in the table: ordinate of the point.

Curve VISU.VISU_Gen.CreateCurveWithZ	(	in Table	theTable,
		in long	theHRow,
		in long	theVRow,
		in long	theZRow
	)

Creates a curve on the basis of points, whose values are taken from the table. Each point has also assigned value, that will be shown as tooltip in Plot2d

Parameters:

theTable	Table containing the data for construction of curves.
theHRow	Index of the row in the table: abscissa of the point.
theVRow	Index of the row in the table: ordinate of the point.
theZRow	Index of the row in the table: assigned value (so-called as Z).

Curve VISU.VISU_Gen.CreateCurveWithZExt	(	in Table	theTable,
		in long	theHRow,
		in long	theVRow,
		in long	theZRow,
		in boolean	theIsV2
	)

Creates a curve on the basis of points, whose values are taken from the table. Each point has also assigned value, that will be shown as tooltip in Plot2d. The curve can be displayed using right axis of Plot2d view.

Parameters:

theTable	Table containing the data for construction of curves.
theHRow	Index of the row in the table: abscissa of the point.
theVRow	Index of the row in the table: ordinate of the point.
theZRow	Index of the row in the table: assigned value (so-called as Z).
theIsV2	Flag allowed to display the curve using right axis of Plot2d view.

Container VISU.VISU_Gen.CreateContainer

(

)

Creates a presentation form containing an array of references to the curves.

Animation VISU.VISU_Gen.CreateAnimation

(

in View3D

theView3d

)

Creates an animation in the 3D view.

Parameters:

theView3d

The 3D view, where the animation will be rendered.

Evolution VISU.VISU_Gen.CreateEvolution

(

in XYPlot

theXYPlot

)

Creates an evolution in the XY plot.

Parameters:

theXYPlot

The XY plot, where the evolution will be rendered.

void VISU.VISU_Gen.DeleteResult

(

in Result

theResult

)

void VISU.VISU_Gen.DeletePrs3d

(

in Prs3d

thePrs3d

)

ColoredPrs3dCache VISU.VISU_Gen.GetColoredPrs3dCache

(

in SALOMEDS::Study

theStudy

)

Get or create ColoredPrs3dCache object.

long VISU.VISU_Gen.CreateClippingPlane	(	in double	X,
		in double	Y,
		in double	Z,
		in double	dX,
		in double	dY,
		in double	dZ,
		in boolean	auto,
		in string	name
	)

void VISU.VISU_Gen.EditClippingPlane	(	in long	id,
		in double	X,
		in double	Y,
		in double	Z,
		in double	dX,
		in double	dY,
		in double	dZ,
		in boolean	auto,
		in string	name
	)

ClippingPlane VISU.VISU_Gen.GetClippingPlane

(

in long

id

)

boolean VISU.VISU_Gen.DeleteClippingPlane

(

in long

id

)

boolean VISU.VISU_Gen.ApplyClippingPlane	(	in Prs3d	thePrs,
		in long	id
	)

boolean VISU.VISU_Gen.DetachClippingPlane	(	in Prs3d	thePrs,
		in long	id
	)

long VISU.VISU_Gen.GetClippingPlanesNb

(

)

boolean VISU.VISU_Gen.VTK2MED	(	in string_array	theVTKFiles,
		in string	theMEDFile,
		in string	theMeshName,
		in double_array	theTStamps
	)

Converts set of VTK files to the one MED-file

Parameters:

theVTKFiles	sequence of VTK files
out	MED-file
theMeshName	mesh name. This parameter can be empty. In this case name of mesh is equal vtk2med
theTSNames	values of time stamps. This array can be empty, in this case values of time stamps will be generated automatically ( 0, 1, 2 ... )

Returns:

TRUE if operation has been completed successfully, FALSE otherwise

long VISU.VISU_Gen.LoadTexture

(

in string

theTextureFile

)

Load texture from file

Parameters:

theTextureFile

texture file name

Returns:

unique texture identifier

IdType VISU.Base.GetID

(

)

[inherited]

Returns ID of the object.

VISUType VISU.Base.GetType

(

)

[inherited]

Returns the type of the presentable object