VISU.CutLines Interface Reference
Cut lines presentation.
More...
import "VISU_Gen.idl";
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 | SetAllCurvesInverted (in boolean theInvert) |
boolean | IsAllCurvesInverted () |
void | SetUseAbsoluteLength (in boolean theAbsLength) |
boolean | IsUseAbsoluteLength () |
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) |
float | GetMemorySize () |
void | RemoveFromStudy () |
IdType | GetID () |
VISUType | GetType () |
void | SetScaling (in Scaling theScaling) |
Scaling | GetScaling () |
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
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. |
Gets the type of orientation in 3D space of the base plane of a cut lines presentation.
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.CutLinesBase.SetNbLines |
( |
in long |
theNb |
) |
[inherited] |
Sets the number of cut lines.
- Parameters:
-
| theNb | The number of cut lines. |
long VISU.CutLinesBase.GetNbLines |
( |
|
) |
[inherited] |
Gets the number of cut lines.
void VISU.CutLinesBase.SetAllCurvesInverted |
( |
in boolean |
theInvert |
) |
[inherited] |
Invert all curves of corresponding table
- Parameters:
-
| theInvert | - Invert all curves, if value is TRUE, else not. |
boolean VISU.CutLinesBase.IsAllCurvesInverted |
( |
|
) |
[inherited] |
Checks the orientation of all curves
- Return values:
-
| TRUE | - if all curves are inverted, else FALSE |
void VISU.CutLinesBase.SetUseAbsoluteLength |
( |
in boolean |
theAbsLength |
) |
[inherited] |
Sets values which cutlines would be shown: aboslute or relative values
- Parameters:
-
| theAbsLength | - boolean value, TRUE or false. |
boolean VISU.CutLinesBase.IsUseAbsoluteLength |
( |
|
) |
[inherited] |
Checks values of cutlines: using aboslute or relative values
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
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.