Package openalea :: Package plantgl :: Package gui :: Module _pglgui :: Class Viewer
[frames] | no frames]

Class Viewer

 object --+    
          |    
??.instance --+
              |
             Viewer

Nested Classes
  camera
  clippingPlanes
  dialog
  frameGL
  grids
  light
  widgetGeometry
Instance Methods
 
__init__(...)
Raises an exception...
 
__reduce__(...)
helper for pickle

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods
 
add(...)
add( (Scene)scene) -> None : add(Scene scene) : add a scene to the current displayed scene.
 
animation(...)
animation( (int)enable) -> None : animation(bool enable = True) : Set viewer in animation mode [No display list, No camera adjutement]
 
display(...)
display( (Scene)scene) -> None : display(Scene scene) : display a scene.
None :

exit()
Exit from Viewer Application.
Scene :

getCurrentScene()
getCurrentScene() : get the current displayed scene
bool :

isRunning()
Tell if viewer is curently running.
 
setBashMode(...)
setBashMode( (bool)enable) -> None : setBashMode(bool enable) : No blocking message from the Viewer.
None :

start()
Start Viewer
bool :

stop()
Stop Viewer
None :

update()
update() : update the current visualization.
 
wait(...)
wait( (int)timeout) -> bool : wait(long timeout = MAXLONG) : wait for the viewer ending.
Properties
  selection
  threaded

Inherited from object: __class__

Method Details

__init__(...)
(Constructor)

 
Raises an exception
This class cannot be instantiated from Python

Overrides: object.__init__

__reduce__(...)

 
helper for pickle

Overrides: object.__reduce__
(inherited documentation)

add(...)
Static Method

 

add( (Scene)scene) -> None :
    add(Scene scene) : add a scene to the current displayed scene.

    C++ signature :
        void add(class TOOLS::RefCountPtr<class PGL::Scene>)

add( (Geometry)geom) -> None :
    add(Geometry geom) : add a particular geometry to the current displayed scene.

    C++ signature :
        void add(class TOOLS::RefCountPtr<class PGL::Geometry>)

add( (Shape)sh) -> None :
    add(Shape sh) : add a particular shape to the current displayed scene.

    C++ signature :
        void add(class TOOLS::RefCountPtr<class PGL::Shape>)

animation(...)
Static Method

 

animation( (int)enable) -> None :
    animation(bool enable = True) : Set viewer in animation mode [No display list, No camera adjutement]

    C++ signature :
        void animation(int)

animation() -> None :

    C++ signature :
        void animation()

display(...)
Static Method

 

display( (Scene)scene) -> None :
    display(Scene scene) : display a scene.

    C++ signature :
        void display(class TOOLS::RefCountPtr<class PGL::Scene>)

display( (Geometry)geom) -> None :
    display(Geometry geom) : display a particular geometry.

    C++ signature :
        void display(class TOOLS::RefCountPtr<class PGL::Geometry>)

display( (Shape)sh) -> None :
    display(Shape sh) : display a particular shape.

    C++ signature :
        void display(class TOOLS::RefCountPtr<class PGL::Shape>)

exit()
Static Method

 
    Exit from Viewer Application. Cannot be restarted after.

    C++ signature :
        void exit()

Returns:
None :

getCurrentScene()
Static Method

 
    getCurrentScene() : get the current displayed scene

    C++ signature :
        class TOOLS::RefCountPtr<class PGL::Scene> getCurrentScene()

Returns:
Scene :

isRunning()
Static Method

 
    Tell if viewer is curently running.

    C++ signature :
        bool isRunning()

Returns:
bool :

setBashMode(...)
Static Method

 

setBashMode( (bool)enable) -> None :
    setBashMode(bool enable) : No blocking message from the Viewer.

    C++ signature :
        void setBashMode(bool)

start()
Static Method

 
    Start Viewer

    C++ signature :
        void start()

Returns:
None :

stop()
Static Method

 
    Stop Viewer

    C++ signature :
        bool stop()

Returns:
bool :

update()
Static Method

 
    update() : update the current visualization.

    C++ signature :
        void update()

Returns:
None :

wait(...)
Static Method

 

wait( (int)timeout) -> bool :
    wait(long timeout = MAXLONG) : wait for the viewer ending.

    C++ signature :
        bool wait(unsigned long)

wait() -> bool :

    C++ signature :
        bool wait()


Property Details

selection

Get Method:
unreachable(...)
Set Method:
unreachable(...)

threaded

Get Method:
unreachable(...)
Set Method:
unreachable(...)