Menu
▾
▴
[Octaviz-cvsupdate] octaviz README,1.3,1.4
|
From: Jonathan S. <jjs...@us...> - 2006-11-10 03:45:45
|
Update of /cvsroot/octaviz/octaviz In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv19103 Modified Files: README Log Message: update general readme Index: README =================================================================== RCS file: /cvsroot/octaviz/octaviz/README,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- README 12 Nov 2004 00:32:26 -0000 1.3 +++ README 10 Nov 2006 03:45:44 -0000 1.4 @@ -1,18 +1,50 @@ -Octaviz is a visualization system for Octave. It is a wrapper that makes all VTK classes accessible from within Octave using the same object-oriented syntax as in C++ or Python. Octaviz also provides high-level functions for 2D and 3D visualization. Using those functions, most common visualization tasks (3D surface plots, contour plots, meshes etc) can be accomplished without any knowledge about VTK. +Octaviz is a visualization system for Octave. It is a wrapper that +makes all VTK classes accessible from within Octave using the same +object-oriented syntax as in C++ or Python. Octaviz also provides +high-level functions for 2D and 3D visualization. Using those +functions, most common visualization tasks (3D surface plots, contour +plots, meshes etc) can be accomplished without any knowledge about +VTK. -Although Octaviz is in active development, it already quite usable and stable. All major features of the wrapper are implemented: all VTK classes are wrapped, array exchange between Octave and VTK works, callbacks work and finally there is experimental CygWin support. Excluding language specific constructs, Python examples (included in VTK) can be used in octave without any modification. To help you get started, about 70 Python examples are converted to Octave and included in Octaviz. +Although Octaviz is in active development, it already quite usable and +stable. All major features of the wrapper are implemented: all VTK +classes are wrapped, array exchange between Octave and VTK works, +callbacks work and finally there is experimental CygWin +support. Excluding language specific constructs, Python examples +(included in VTK) can be used in octave without any modification. To +help you get started, about 70 Python examples are converted to Octave +and included in Octaviz. -Octaviz consists of two parts: -wrappers for all VTK classes and high-level Octave scripts that hide VTK internals and provide visualization capabilities without requiring any VTK knowledge. -VTK classes can be used in Octave as easily as they are used in Python and with the same syntax. Unlike other scripts or toolboxes for octave, octaviz uses object-oriented syntax. Octaviz wraps each VTK class into an Octave function of the same name. Those function are used as objects: An instance of a VTK class are created by calling corresponding octave function without parameters. For example, command "ren =vtkRenderer();" creates an instance of vtkRenderer class that is kept in octave variable "ren". Methods within a class are accessed directly using C++ (or Python) syntax. For example, using the above created object ren, the method Render is accessible as "ren.Render()". Online help is available for each class and method: vtkClass("Help") displays the description of vtkClass, while vtkClass("MethodName","Help") displays help for the method vtkClass.MethodName. List of available methods for a class can be obtained as vtkClass("List"). +Octaviz consists of two parts: wrappers for all VTK classes and +high-level Octave scripts that hide VTK internals and provide +visualization capabilities without requiring any VTK knowledge. VTK +classes can be used in Octave as easily as they are used in Python and +with the same syntax. Unlike other scripts or toolboxes for octave, +octaviz uses object-oriented syntax. Octaviz wraps each VTK class into +an Octave function of the same name. Those function are used as +objects: An instance of a VTK class are created by calling +corresponding octave function without parameters. For example, command +"ren =vtkRenderer();" creates an instance of vtkRenderer class that is +kept in octave variable "ren". Methods within a class are accessed +directly using C++ (or Python) syntax. For example, using the above +created object ren, the method Render is accessible as +"ren.Render()". Online help is available for each class and method: +vtkClass("Help") displays the description of vtkClass, while +vtkClass("MethodName","Help") displays help for the method +vtkClass.MethodName. List of available methods for a class can be +obtained as vtkClass("List"). -Octaviz has been developed for Linux with X-Window System and OpenGL but it should work on any platform that supports X and VTK. Octaviz should work under CygWin too but this port requires more testing. Any feedback regarding Octaviz in CygWin is welcome. +Octaviz has been developed for Linux with X-Window System and OpenGL +but it should work on any platform that supports X and VTK. Octaviz +should work under CygWin too but this port requires more testing. Any +feedback regarding Octaviz in CygWin is welcome. BUILDING INSTRUCTIONS Linux: -You'll need octave 2.1.53 or later and VTK CVS to build octaviz. +You'll need octave 2.1.53 or later and VTK-5.0 or later to build +octaviz. - run ccmake . in Octaviz root directory - press "c" to configure - press "g" to generate Makefiles |
