API documentation for visualization library

Michael Galloy

single page | use frames     summary     class     fields     routine details     file attributes

x3dom/

visgrx3dom__define.pro

includes main-level program

Destination class for X3DOM graphics suitable for display on a web page by a modern browser.

Class description for visgrx3dom

Properties

indent get set

string to indent lines in the output by; default is to use two spaces

_extra init
filename get set

filename to send output to

dimensions get set

dimensions of output graphic

graphics_tree get set

graphics hierarchy to draw by default

Routines

visgrx3dom::draw [, tree] [, /full_html]

Draw the given scene and send its output to the file specified by the FILENAME property.

visgrx3dom::getProperty, dimensions=dimensions, filename=filename, graphics_tree=graphics_tree, indent=indent

Retrieve properties.

visgrx3dom::setProperty, dimensions=dimensions, filename=filename, graphics_tree=graphics_tree, indent=indent

Set properties.

visgrx3dom::cleanup

Free resources.

result = visgrx3dom::init( [_extra=keywords])

Retrieve properties.

visgrx3dom__define

Define instance variables.

Routine details

top visgrx3dom::draw

visgrx3dom::draw [, tree] [, /full_html]

Draw the given scene and send its output to the file specified by the FILENAME property.

Parameters

tree in optional type=objref

object graphics hierarchy to draw; optional, but then GRAPHICS_TREE property must be set

Keywords

full_html in optional type=boolean

set to write an entire HTML file instead of just the w3dom content

top visgrx3dom::getProperty

visgrx3dom::getProperty, dimensions=dimensions, filename=filename, graphics_tree=graphics_tree, indent=indent

Retrieve properties.

Keywords

dimensions

dimensions of output graphic

filename

filename to send output to

graphics_tree

graphics hierarchy to draw by default

indent

string to indent lines in the output by; default is to use two spaces

top visgrx3dom::setProperty

visgrx3dom::setProperty, dimensions=dimensions, filename=filename, graphics_tree=graphics_tree, indent=indent

Set properties.

Keywords

dimensions

dimensions of output graphic

filename

filename to send output to

graphics_tree

graphics hierarchy to draw by default

indent

string to indent lines in the output by; default is to use two spaces

top visgrx3dom::cleanup

visgrx3dom::cleanup

Free resources.

top visgrx3dom::init

result = visgrx3dom::init( [_extra=keywords])

Retrieve properties.

Return value

1 if successfully initialized, 0 if failed

Keywords

_extra in optional type=keywords

properties

top visgrx3dom__define

visgrx3dom__define

Define instance variables.

File attributes

Modification date: Fri Sep 9 10:10:46 2011
Lines: 435
Docformat: rst rst