Cut planes interface. More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.CutPlanes:

Public Types
enum	Orientation { XY, YZ, ZX }
Public Member Functions
void	SetOrientation (in Orientation theOrientation, in double theXAngle, in double theYAngle)
Orientation	GetOrientationType ()
double	GetRotateX ()
double	GetRotateY ()
void	SetDisplacement (in double theDisp)
double	GetDisplacement ()
void	SetPlanePosition (in long thePlaneNumber, in double thePlanePosition)
void	SetDefault (in long thePlaneNumber)
double	GetPlanePosition (in long thePlaneNumber)
boolean	IsDefault (in long thePlaneNumber)
void	SetNbPlanes (in long theNb)
long	GetNbPlanes ()
boolean	IsBarVisible ()
void	SetBarVisible (in boolean theVisible)
void	SetGaussMetric (in GaussMetric theGaussMetric)
GaussMetric	GetGaussMetric ()
void	SetLinkColor (in SALOMEDS::Color theColor)
SALOMEDS::Color	GetLinkColor ()
void	SetTitle (in string theName)
string	GetTitle ()
void	SetScalarMode (in long theScalarMode)
long	GetScalarMode ()
void	SetIsDistributionVisible (in boolean theIs)
boolean	GetIsDistributionVisible ()
	Gets current visibility of a distribution curve.
boolean	IsScalarFilterUsed ()
	Gets current filtering by scalars mode.
void	UseScalarFiltering (in boolean theUseScalarFilter)
void	SetScalarFilterRange (in double theMin, in double theMax)
double	GetScalarFilterMin ()
double	GetScalarFilterMax ()
void	AddMeshOnGroup (in string theGroupName)
void	RemoveAllGeom ()
void	SetRange (in double theMin, in double theMax)
double	GetMin ()
double	GetMax ()
void	SetSourceRange ()
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	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)
void	SetMarkerStd (in MarkerType theType, in MarkerScale theScale)
void	SetMarkerTexture (in long theTextureId)
MarkerType	GetMarkerType ()
MarkerScale	GetMarkerScale ()
long	GetMarkerTexture ()
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()
void	SetScaling (in Scaling theScaling)
Scaling	GetScaling ()
void	UseDeformation (in boolean theFlag)
boolean	IsDeformed ()
void	SetScale (in double theScale)
double	GetScale ()
void	SetVectorialField (in Entity theEntity, in string theFieldName)
Entity	GetVectorialFieldEntity ()
string	GetVectorialFieldName ()

Detailed Description

Presentation parameters of Cut planes presentation. This type of presentation consists of cutting your initial mesh by a definite number of planes. As the result you will see these planes which will be cutted by the borders of the mesh.

Member Enumeration Documentation

enum VISU::CutPlanes::Orientation

This enumeration contains a set of elements defining the type of orientation in 3D space of the cut planes.

Enumerator:

XY	The object is located in the plane formed by X and Y axis.
YZ	The object is located in the plane formed by Y and Z axis.
ZX

Implements VISU.ColoredPrs3dBase.

Member Function Documentation

void VISU.CutPlanes.SetOrientation	(	in Orientation	theOrientation,
		in double	theXAngle,
		in double	theYAngle
	)

Sets the type of orientation in 3D space of cut planes presentation.

Parameters:

theOrientation	This parameter defines the type of orientation of cut planes in 3D space. It is taken from the Orientation enumeration.
theXAngle	The angle of rotation of the cut planes around the first axis of the chosen orientation.
theXAngle	The angle of rotation of the cut planes around the second axis of the chosen orientation.

Orientation VISU.CutPlanes.GetOrientationType ( )

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

double VISU.CutPlanes.GetRotateX ( )

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

double VISU.CutPlanes.GetRotateY ( )

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

void VISU.CutPlanes.SetDisplacement ( in double theDisp )

Sets the displacement of the cut planes in 3D space.

Parameters:

theDisp This parameter defines position of the cut planes in 3D space. It varies from 0 to 1. If the chosen value is 0.5, the cut planes will be evenly located regarding each other; in other words, the distance between all of them will be equal. If the value is higher or lower than 0.5, the planes will be displaced to one or another side.

double VISU.CutPlanes.GetDisplacement ( )

Gets the displacement of the cut planes in 3D space.

void VISU.CutPlanes.SetPlanePosition	(	in long	thePlaneNumber,
		in double	thePlanePosition
	)

Sets the position of a definite cut plane.

Parameters:

thePlaneNumber	The number of this cut plane.
thePlanePosition	The position of this cut plane.

void VISU.CutPlanes.SetDefault ( in long thePlaneNumber )

Sets the position of the choosen plane to default value.

Parameters:

thePlaneNumber The number of this cut plane.

double VISU.CutPlanes.GetPlanePosition ( in long thePlaneNumber )

Gets the position of the choosen plane

boolean VISU.CutPlanes.IsDefault ( in long thePlaneNumber )

Determines whether the choosen plane has default position.

Parameters:

thePlaneNumber The number of this cut plane.

void VISU.CutPlanes.SetNbPlanes ( in long theNb )

Sets the number of cut planes.

Parameters:

theNb The number of cut planes.

long VISU.CutPlanes.GetNbPlanes ( )

Gets the number of cut planes.

boolean VISU.ScalarMap.IsBarVisible ( ) [inherited]

Returns visibility state of scalar bar

void VISU.ScalarMap.SetBarVisible ( in boolean theVisible ) [inherited]

Sets visibility state of scalar bar

void VISU.ScalarMap.SetGaussMetric ( in GaussMetric theGaussMetric ) [inherited]

Sets the gauss metric for the presentation.

Parameters:

theGaussMetric The value of this parameter is taken from the GaussMetric enumeration.

GaussMetric VISU.ScalarMap.GetGaussMetric ( ) [inherited]

Gets the gauss metric of the presentation.

void VISU.ScalarMap.SetLinkColor ( in SALOMEDS::Color theColor ) [inherited]

Sets the color of mesh links.

Parameters:

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

SALOMEDS::Color VISU.ScalarMap.GetLinkColor ( ) [inherited]

Gets the color of mesh links.

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

void VISU.ColoredPrs3d.SetIsDistributionVisible ( in boolean theIs ) [inherited]

Set the visibility of a distribution curve.

Parameters:

theIs is used to switch on/off the visibility of a distribution curve.

boolean VISU.ColoredPrs3d.GetIsDistributionVisible ( ) [inherited]

boolean VISU.ColoredPrs3d.IsScalarFilterUsed ( ) [inherited]

void VISU.ColoredPrs3d.UseScalarFiltering ( in boolean theUseScalarFilter ) [inherited]

void VISU.ColoredPrs3d.SetScalarFilterRange	(	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.
theIsFilter	if true then filter by scalars.

double VISU.ColoredPrs3d.GetScalarFilterMin ( ) [inherited]

double VISU.ColoredPrs3d.GetScalarFilterMax ( ) [inherited]

void VISU.ColoredPrs3d.AddMeshOnGroup ( in string theGroupName ) [inherited]

Add group as geometry of presentation.

Parameters:

theMeshName	- mesh name
theGroupName	- group name

void VISU.ColoredPrs3d.RemoveAllGeom ( ) [inherited]

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

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

double VISU.ColoredPrs3dBase.GetMin ( ) [inherited]

Gets the min boundary of the scalar bar.

double VISU.ColoredPrs3dBase.GetMax ( ) [inherited]

Gets the max boundary of the scalar bar.

void VISU.ColoredPrs3dBase.SetSourceRange ( ) [inherited]

Sets scalar range that corresponds to the source data.

double VISU.ColoredPrs3dBase.GetSourceMin ( ) [inherited]

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

double VISU.ColoredPrs3dBase.GetSourceMax ( ) [inherited]

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

boolean VISU.ColoredPrs3dBase.IsRangeFixed ( ) [inherited]

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

void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.GetPosX ( ) [inherited]

Gets horizontal position of the scalar bar origin.

double VISU.ColoredPrs3dBase.GetPosY ( ) [inherited]

Gets vertical position of the scalar bar origin.

void VISU.ColoredPrs3dBase.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.ColoredPrs3dBase.GetWidth ( ) [inherited]

Gets the width of this presentable object.

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

double VISU.ColoredPrs3dBase.GetHeight ( ) [inherited]

Gets the height of this presentable object.

Returns:: A double value corresponding to the height of this presentable object.

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

void VISU.Prs3d.SetMarkerStd	(	in MarkerType	theType,
		in MarkerScale	theScale
	)		`[inherited]`

Set standard point marker for the object

Parameters:

theType	standard marker type
theScale	standard marker scale

void VISU.Prs3d.SetMarkerTexture ( in long theTextureId ) [inherited]

Set custom point marker for the object. The texture can be added by LoadTexture() function

Parameters:

theTextureId texture ID

MarkerType VISU.Prs3d.GetMarkerType ( ) [inherited]

Get type of the point marker assigned to the object

Returns:: current marker type (MT_NONE if no marker is set)

MarkerScale VISU.Prs3d.GetMarkerScale ( ) [inherited]

Get scale of the point marker assigned to the object

Returns:: current marker scale (MS_NONE if no marker is set)

long VISU.Prs3d.GetMarkerTexture ( ) [inherited]

Get texture idenifier of the point marker assigned to the object

Returns:: marker texture ID (0 if no marker set)

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

void VISU.ScaledPrs3d.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.ScaledPrs3d.GetScaling ( ) [inherited]

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

void VISU.OptionalDeformation.UseDeformation ( in boolean theFlag ) [inherited]

Sets the deformation flag of the presentatable object.

Parameters:

theFlag Boolean value defining the deformation flag of this presentable object.

boolean VISU.OptionalDeformation.IsDeformed ( ) [inherited]

Gets the deformation flag of the presentatable object.

void VISU.Deformation.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.Deformation.GetScale ( ) [inherited]

Gets the scale of the presentatable object.

void VISU.Deformation.SetVectorialField	(	in Entity	theEntity,
		in string	theFieldName
	)		`[inherited]`

Sets the vectorial field

Parameters:

theEntity	- entity of vectorial field
theFieldName	- the name of vectorial field

Entity VISU.Deformation.GetVectorialFieldEntity ( ) [inherited]

Get vectorial entity

string VISU.Deformation.GetVectorialFieldName ( ) [inherited]

Get scalar field name

VISU.CutPlanes Interface Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation