VISU.CutLines Interface Reference

Cut lines presentation. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.CutLines:


Public Types
enum	Orientation { HORIZONTAL, VERTICAL }
Public Member Functions
void	SetOrientation (in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle)
void	SetOrientation2 (in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle)
CutPlanes::Orientation	GetOrientationType ()
CutPlanes::Orientation	GetOrientationType2 ()
double	GetRotateX ()
double	GetRotateX2 ()
double	GetRotateY ()
double	GetRotateY2 ()
void	SetDisplacement (in double theDisp)
void	SetDisplacement2 (in double theDisp)
double	GetDisplacement ()
double	GetDisplacement2 ()
void	SetBasePlanePosition (in double thePlanePosition)
double	GetBasePlanePosition ()
void	SetLinePosition (in long thePlaneNumber, in double thePlanePosition)
double	GetLinePosition (in long thePlaneNumber)
void	SetDefault ()
boolean	IsDefault ()
void	SetDefaultPosition (in long thePlaneNumber)
boolean	IsDefaultPosition (in long thePlaneNumber)
void	SetNbLines (in long theNb)
long	GetNbLines ()
void	SetScaling (in Scaling theScaling)
Scaling	GetScaling ()
void	SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
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

Presentation parameters of a Cut lines presentation. Cut Lines is a type of presentation which displays colored cells with applied scalar values on the mesh where lines are placed. The procedure of construction of a Cut Lines presentation reuses the algorithm of creation of Cut Planes presentation and consists of two steps:

1. From Cut Planes presentation one plane is taken and it is used as base plane for construction of cut lines. 2. This plane is cut by a regular array of planes. The result of this operation is a regular array of lines in space, belonging to the same plane and having the same orientation. They are located inside or on the mesh.

Member Enumeration Documentation

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.CutLines.SetOrientation ( in CutPlanes::Orientation theOrientation,

in double theXAngle,

in double theYAngle

)

Sets the type of orientation in 3D space of the base plane of a cut lines presentation.
Parameters:

theOrientation The orientation of the base plane in 3D space.

theXAngle The angle of rotation of the base plane around the first axis of the chosen orientation.

theXAngle The angle of rotation of the base plane around the second axis of the chosen orientation.

void VISU.CutLines.SetOrientation2 ( in CutPlanes::Orientation theOrientation,

in double theXAngle,

in double theYAngle

)

Sets the type of orientation in 3D space of the cutting planes of a cut lines presentation.
Parameters:

theOrientation This parameter defines the type of orientation of the cutting planes in 3D space. It is taken from the Orientation enumeration.

theXAngle The angle of rotation of the cutting planes around the first axis of the chosen orientation.

theXAngle The angle of rotation of the cutting planes around the second axis of the chosen orientation.

CutPlanes::Orientation VISU.CutLines.GetOrientationType ( )

Gets the type of orientation in 3D space of the base plane of a cut lines presentation.

CutPlanes::Orientation VISU.CutLines.GetOrientationType2 ( )

Gets the type of orientation in 3D space of the cutting planes of a cut lines presentation.

double VISU.CutLines.GetRotateX ( )

Gets rotation angle of the base plane around the first axis of the chosen orientation.

double VISU.CutLines.GetRotateX2 ( )

Gets rotation angle of the cutting planes around the first axis of the chosen orientation.

double VISU.CutLines.GetRotateY ( )

Gets rotation angle of the base plane around the second axis of the chosen orientation.

double VISU.CutLines.GetRotateY2 ( )

Gets rotation angle of the cutting planes around the second axis of the chosen orientation.

void VISU.CutLines.SetDisplacement ( in double theDisp )

Sets the displacement of the base plane of the cut lines presentation in 3D space.

Parameters:

theDisp This parameter defines position of the base plane in 3D space. It varies from 0 to 1.

void VISU.CutLines.SetDisplacement2 ( in double theDisp )

Sets the displacement of the cutting planes of the cut lines presentation in 3D space.

Parameters:

theDisp This parameter defines position of the cutting planes in 3D space. It varies from 0 to 1.

double VISU.CutLines.GetDisplacement ( )

Gets the displacement of the base plane of the cut lines presentation in 3D space.

double VISU.CutLines.GetDisplacement2 ( )

Gets the displacement of the cutting planes of the cut lines presentation in 3D space.

void VISU.CutLines.SetBasePlanePosition ( in double thePlanePosition )

Sets the position of the base plane in 3D space.
Parameters:

thePlanePosition A double value defining the position of the base plane in 3D space.

double VISU.CutLines.GetBasePlanePosition ( )

Gets the position of the base plane in 3D space.

void VISU.CutLines.SetLinePosition ( in long thePlaneNumber,

in double thePlanePosition

)

Sets the position of one of cutting planes in 3D space.
Parameters:

thePlaneNumber A long value defining the order number of this cutting plane.

thePlanePosition A double value defining the position of the base plane in 3D space.

double VISU.CutLines.GetLinePosition ( in long thePlaneNumber )

Gets the position of one of cutting planes in 3D space.
Parameters:

thePlaneNumber A long value defining the order number of this cutting plane.

void VISU.CutLines.SetDefault ( )

Sets the position of the base plane to default value.

boolean VISU.CutLines.IsDefault ( )

Determines whether the base plane has default position.
Returns:
True if the base plane has default position.

void VISU.CutLines.SetDefaultPosition ( in long thePlaneNumber )

Sets the position of the choosen cutting plane to default value.
Parameters:

thePlaneNumber The number of this cutting plane.

boolean VISU.CutLines.IsDefaultPosition ( in long thePlaneNumber )

Determines whether the choosen cutting plane has default position.
Parameters:

thePlaneNumber The number of this cutting plane.

Returns:
True if this cutting plane has default position.

void VISU.CutLines.SetNbLines ( in long theNb )

Sets the number of cut lines.
Parameters:

theNb The number of cut lines.

long VISU.CutLines.GetNbLines ( )

Gets the number of cut lines.

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.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.CutLines Interface Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation