VISU.View3D Interface Reference

3D view interface More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.View3D:

Public Types
typedef double	XYZ [3]
enum	ViewType {   FRONT, BACK, LEFT, RIGHT,   TOP, BOTTOM }
enum	Axis { XAxis, YAxis, ZAxis }
enum	ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, MESSAGES }
enum	ViewPosition {   TOP, CENTER, BOTTOM, RIGHT,   LEFT }
Public Member Functions
void	FitAll ()
void	SetView (in ViewType theType)
void	SetPointOfView (in XYZ theCoord)
XYZ	GetPointOfView ()
void	SetViewUp (in XYZ theDir)
XYZ	GetViewUp ()
void	SetFocalPoint (in XYZ theDir)
XYZ	GetFocalPoint ()
void	SetParallelScale (in double theScale)
double	GetParallelScale ()
void	ScaleView (in Axis theAxis, in double theParam)
void	RemoveScale ()
boolean	SaveViewParams (in string theName)
boolean	RestoreViewParams (in string theName)
void	ShowPart (in ViewRepresentation ViewRepr, in boolean state)
boolean	IsPartShown (in ViewRepresentation ViewRepr)
void	SetViewWidth (in long Width)
void	SetViewHeight (in long Height)
long	GetViewWidth ()
long	GetViewHeight ()
void	SetViewPositionHorizontal (in ViewPosition ViewPosHor)
void	SetViewPositionVertical (in ViewPosition ViewPosVer)
void	SetRelativePosition (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	SetTitle (in string theTitle)
string	GetTitle ()
void	SetBackground (in SALOMEDS::Color theColor)
SALOMEDS::Color	GetBackground ()
void	Minimize ()
void	Restore ()
void	Maximize ()
void	EraseAll ()
void	DisplayAll ()
void	Erase (in PrsObject thePrsObj)
void	Display (in PrsObject thePrsObj)
void	DisplayOnly (in PrsObject thePrsObj)
void	Update ()
boolean	SavePicture (in string theFileName)
IdType	GetID ()
VISUType	GetType ()

---

Detailed Description

This interface contains a set of methods necessary for representation of objects in 3D space.

---

Member Typedef Documentation

typedef double VISU.View3D.XYZ[3]

Data type defining coordinates in 3D space.

---

Member Enumeration Documentation

enum VISU::View3D::ViewType

This enumeration contains a set of elements determining a predefined point of view (position of the camera in 3D space relative to the presentable object). Enumeration values: FRONT  BACK  LEFT  RIGHT  TOP  BOTTOM

enum VISU::View3D::Axis

This enumeration contains a set of elements determining the axis Enumeration values: XAxis  YAxis  ZAxis

enum VISU::View::ViewRepresentation [inherited]

Enumeration values: OBJECTBROWSER  VIEWER  PYTHON  MESSAGES

enum VISU::View::ViewPosition [inherited]

Enumeration values: TOP  CENTER  BOTTOM  RIGHT  LEFT

---

Member Function Documentation

void VISU.View3D.FitAll (   )

Makes all presentations, which are currently present in the view, completely visible.

void VISU.View3D.SetView (  in ViewType  theType  )

Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means a predefined position of the camera in 3D space with respect to the object which is represented.)

void VISU.View3D.SetPointOfView (  in XYZ  theCoord  )

Sets the position of the camera in 3D space. This point is used as the first point of the vector defining the view direction of the camera.

XYZ VISU.View3D.GetPointOfView (   )

Gets the position of the camera in 3D space.This point is used as the first point of the vector defining the view direction of the camera.

void VISU.View3D.SetViewUp (  in XYZ  theDir  )

Sets the vertical line of the camera in 3D space.

XYZ VISU.View3D.GetViewUp (   )

Gets the vertical line of the camera in 3D space.

void VISU.View3D.SetFocalPoint (  in XYZ  theDir  )

Sets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera.

XYZ VISU.View3D.GetFocalPoint (   )

Gets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera.

void VISU.View3D.SetParallelScale (  in double  theScale  )

Zooming of the presentable object. Sets the scale.

double VISU.View3D.GetParallelScale (   )

Zooming of the presentable object. Gets the scale.

void VISU.View3D.ScaleView (  in Axis  theAxis, in double  theParam )

Scaling of the view along a definite axis. Parameters: theAxis  The axis of the scaling theParam  The coefficient of the scaling

void VISU.View3D.RemoveScale (   )

Removes the scaling of the view.

boolean VISU.View3D.SaveViewParams (  in string  theName  )

Saves view parameters. Returns: True if the view parameters have been created, False if the parameters have been modified. Parameters: theName  The name under which the view parameters will be saved.

boolean VISU.View3D.RestoreViewParams (  in string  theName  )

Restores view parameters. Returns: True if the view parameters have been found and applied to the view, False if the parameters with this name don't exist. Parameters: theName  The name of the view parameters which will be restored.

void VISU.View.ShowPart (  in ViewRepresentation  ViewRepr, in boolean  state )  [inherited]

boolean VISU.View.IsPartShown (  in ViewRepresentation  ViewRepr  )  [inherited]

void VISU.View.SetViewWidth (  in long  Width  )  [inherited]

void VISU.View.SetViewHeight (  in long  Height  )  [inherited]

long VISU.View.GetViewWidth (   )  [inherited]

long VISU.View.GetViewHeight (   )  [inherited]

void VISU.View.SetViewPositionHorizontal (  in ViewPosition  ViewPosHor  )  [inherited]

void VISU.View.SetViewPositionVertical (  in ViewPosition  ViewPosVer  )  [inherited]

void VISU.View.SetRelativePosition (  in double  x, in double  y )  [inherited]

void VISU.View.SetRelativeSize (  in double  x, in double  y )  [inherited]

void VISU.View.SetTitle (  in string  theTitle  )  [inherited]

Sets the title of the View frame. Parameters: theTitle  String parameter defining the title of the View frame.

string VISU.View.GetTitle (   )  [inherited]

Gets the title of the View frame.

void VISU.View.SetBackground (  in SALOMEDS::Color  theColor  )  [inherited]

Sets background color of the View frame. Parameters: theColor  Background color defined in SALOMEDS::Color enumeration.

SALOMEDS::Color VISU.View.GetBackground (   )  [inherited]

Gets background color of the View frame.

void VISU.View.Minimize (   )  [inherited]

Minimizes to the task bar or to the bottom of the Desktop the View frame.

void VISU.View.Restore (   )  [inherited]

Restores the View frame.

void VISU.View.Maximize (   )  [inherited]

Maximizes the View frame.

void VISU.View.EraseAll (   )  [inherited]

Removes all presentations (presentable objects) from the view.

void VISU.View.DisplayAll (   )  [inherited]

Displays all presentations (presentable objects) in the view.

void VISU.View.Erase (  in PrsObject  thePrsObj  )  [inherited]

Removes a definite presentation (presentable object) from the view. Parameters: thePrsObj  The presentation (presentable object) which should be deleted.

void VISU.View.Display (  in PrsObject  thePrsObj  )  [inherited]

Displays a definite presentation (presentable object) in the view. Parameters: thePrsObj  The presentation (presentable object) which should be displayed.

void VISU.View.DisplayOnly (  in PrsObject  thePrsObj  )  [inherited]

Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view. Parameters: thePrsObj  The presentation (presentable object) which should be displayed.

void VISU.View.Update (   )  [inherited]

Updates the view.

boolean VISU.View.SavePicture (  in string  theFileName  )  [inherited]

Saves the view. Parameters: theFileName  The name of the file where the view will be saved. Returns: True, if the view have been saved successfully.

IdType VISU.Base.GetID (   )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (   )  [inherited]

Returns the type of the presentable object

---