VISU.Vectors Interface Reference

Interface of the vector presentation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.Vectors:


Public Types
enum	GlyphType { ARROW, CONE2, CONE6, NONE }
enum	GlyphPos { CENTER, TAIL, HEAD }
enum	Orientation { HORIZONTAL, VERTICAL }
Public Member Functions
void	SetLineWidth (in double theWidth)
double	GetLineWidth ()
void	SetGlyphType (in GlyphType theType)
GlyphType	GetGlyphType ()
void	SetGlyphPos (in GlyphPos thePos)
GlyphPos	GetGlyphPos ()
void	SetScale (in double theScale)
double	GetScale ()
boolean	IsColored ()
void	ShowColored (in boolean theColored)
SALOMEDS::Color	GetColor ()
void	SetColor (in SALOMEDS::Color theColor)
void	SetScaling (in Scaling theScaling)
Scaling	GetScaling ()
void	SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetMeshOnGroup (in string theMeshName, in string theGroupName)
long	AddMeshOnGroup (in string theMeshName, in string theGroupName)
void	SetScalarMap (in string theMeshName, in Entity theEntity, in string theFieldName, in long theStampsNum)
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
long	GetScalarMode ()
double	GetMin ()
double	GetMax ()
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	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()

Detailed Description

This interface contains presentation parameters of vector presentations.

Member Enumeration Documentation

enum VISU::Vectors::GlyphType

This enumeration contains a set of elements defining the type of representation of the vector head.
Enumerator:

ARROW

CONE2

CONE6

NONE

enum VISU::Vectors::GlyphPos

This enumeration contains a set of elements defining the position of the vector head.
Enumerator:

CENTER In the center of the vector.

TAIL In the tail of the vector.

HEAD In the head of the vector.

enum VISU::ScalarMap::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.Vectors.SetLineWidth ( in double theWidth )

Sets the width of the lines of the vectors.
Parameters:

theWidth A double value defining the width of the lines of the vectors.

double VISU.Vectors.GetLineWidth ( )

Gets the width of the lines of the vectors.

void VISU.Vectors.SetGlyphType ( in GlyphType theType )

Sets the type of representation of the vector head.
Parameters:

theType This parameter defines the type of representation of the vector head. This value is taken from the GlyphType enumeration.

GlyphType VISU.Vectors.GetGlyphType ( )

Gets the type of representation of the vector head.

void VISU.Vectors.SetGlyphPos ( in GlyphPos thePos )

Sets the position of the vector head.
Parameters:

thePos This parameter defines the position of the vector head. This value is taken from the GlyphPos enumeration.

GlyphPos VISU.Vectors.GetGlyphPos ( )

Gets the position of the vector head.

void VISU.DeformedShape.SetScale ( in double theScale ) [inherited]

Sets the scale of the presentatable object.
Parameters:

theScale Double value defining the scale of this presentable object.

double VISU.DeformedShape.GetScale ( ) [inherited]

Gets the scale of the presentatable object.

boolean VISU.DeformedShape.IsColored ( ) [inherited]

This boolean method returns True if this deformed shape presentation is colored.

void VISU.DeformedShape.ShowColored ( in boolean theColored ) [inherited]

Shows this presentation in colored mode.
Parameters:

theColored If this boolean parameter is True this presentable object will be shown in colored mode.

SALOMEDS::Color VISU.DeformedShape.GetColor ( ) [inherited]

Gets the color of this presentable object.
Returns:
The color of this presentable object.

void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) [inherited]

Sets the color of this presentation.
Parameters:

theColor The color of this presentation. This parameter is taken from the Color enumeration.

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.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.ScalarMap.GetBarOrientation ( ) [inherited]

Gets the type of orientation of the scalar bar (to provide backward compatibility).

void VISU.ScalarMap.SetMeshOnGroup ( in string theMeshName,

in string theGroupName

) [inherited]

PrsMerger method: Set mesh on group as geometry of presentation.(clear all previously added groups).
Parameters:

theMeshName - mesh name

theGroupName - group name

long VISU.ScalarMap.AddMeshOnGroup ( in string theMeshName,

in string theGroupName

) [inherited]

PrsMerger method: Add group as geometry of presentation.
Parameters:

theMeshName - mesh name

theGroupName - group name

void VISU.ScalarMap.SetScalarMap ( in string theMeshName,

in Entity theEntity,

in string theFieldName,

in long theStampsNum

) [inherited]

PrsMerger method: Set scalar map of presentation.
Parameters:

theMeshName - mesh name

theFieldName - the name of scalar field

theStampsNum - the iteration number for scalar field

theEntity - entity of scalar field

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.

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.Prs3d.SetOffset ( in float theDx,

in float theDy,

in float theDz

) [inherited]

void VISU.Prs3d.GetOffset ( out float theDx,

out float theDy,

out float theDz

) [inherited]

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

VISU.Vectors Interface Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation