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)
boolean	ExportTableToFile (in SALOMEDS::SObject theTable, in string theFileName)
Result	ImportFile (in string theFileName)
Result	CopyAndImportFile (in string theFileName)
Result	ImportMed (in SALOMEDS::SObject theMedSObject)
Result	ImportMedField (in SALOME_MED::FIELD theField)
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 double theIteration)
DeformedShape	DeformedShapeOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
Vectors	VectorsOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
IsoSurfaces	IsoSurfacesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
StreamLines	StreamLinesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
CutPlanes	CutPlanesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
CutLines	CutLinesOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration)
Table	CreateTable (in string theTableEntry)
Curve	CreateCurve (in Table theTable, in long theHRow, in long theVRow)
Container	CreateContainer ()
Animation	CreateAnimation (in View3D theView3d)
void	DeleteResult (in Result theResult)
void	DeletePrs3d (in Prs3d thePrs3d)
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  )

Imports tables from a file and create TableAttribute in Sudy

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

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 double  theIteration )

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. theIteration  Number of iteration on the field

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

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. theIteration  Number of iteration on the field

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

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. theIteration  Number of iteration on the field

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

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. theIteration  Number of iteration on the field

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

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. theIteration  Number of iteration on the field

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

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. theIteration  Number of iteration on the field

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

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. theIteration  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. HRow  Index of the row in the table: abscissa of the point. VRow  Index of the row in the table: ordinate of the point.

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.

void VISU.VISU_Gen.DeleteResult (  in Result  theResult  )

void VISU.VISU_Gen.DeletePrs3d (  in Prs3d  thePrs3d  )

IdType VISU.Base.GetID (   )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (   )  [inherited]

Returns the type of the presentable object

---