API documentation for visualization library

Michael Galloy

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

povray/

visgrpovraytubes__define.pro

object graphics

includes main-level program

Represents a polyline in 3-dimensions by a series of cones.

Examples

To create some tubes to visualize streamlines of a vector field:

streamlines = obj_new('VISgrPOVRayTubes', data=verts, polylines=conn, $ /open, radius=0.5 - 0.5 / (findgen(nverts) + 1.1), $ color=[r[mag], g[mag], b[mag]])
See the example attached to the end of this file as a main-level program (only available if you have the source code version of this routine):
IDL> .run visgrpovraytubes__define
This should produce:

Class description for visgrpovraytubes

Inheritance

All ancestor classes: IDLGRPOLYLINE IDLGRGRAPHIC IDLGRCOMPONENT IDLITCOMPONENT visgrpovrayobject

Properties

_extra set init
open get set init

set to control whether the ends are open or closed

finish get set init
radius get set init

radius of the cones; either a scalar or a fltarr(n) where there are n points in the polyline; default value is 1.0

no_shadow get set init
_ref_extra get

Routines

visgrpovraytubes::getProperty, open=open, radius=radius, finish=finish, no_shadow=no_shadow, _ref_extra=_ref_extra

Get properties.

visgrpovraytubes::setProperty, open=open, radius=radius, finish=finish, no_shadow=no_shadow, _extra=_extra

Set properties.

visgrpovraytubes::cleanup

Free resources.

result = visgrpovraytubes::init(open=open, radius=radius, finish=finish, no_shadow=no_shadow, _extra=_extra)

Create a POV-Ray tube object.

visgrpovraytubes__define

Define instance variables.

Routine details

top visgrpovraytubes::getProperty

visgrpovraytubes::getProperty, open=open, radius=radius, finish=finish, no_shadow=no_shadow, _ref_extra=_ref_extra

Get properties.

Keywords

open

set to control whether the ends are open or closed

radius

radius of the cones; either a scalar or a fltarr(n) where there are n points in the polyline; default value is 1.0

finish
no_shadow
_ref_extra

top visgrpovraytubes::setProperty

visgrpovraytubes::setProperty, open=open, radius=radius, finish=finish, no_shadow=no_shadow, _extra=_extra

Set properties.

Keywords

open

set to control whether the ends are open or closed

radius

radius of the cones; either a scalar or a fltarr(n) where there are n points in the polyline; default value is 1.0

finish
no_shadow
_extra

top visgrpovraytubes::cleanup

visgrpovraytubes::cleanup

Free resources.

top visgrpovraytubes::init

result = visgrpovraytubes::init(open=open, radius=radius, finish=finish, no_shadow=no_shadow, _extra=_extra)

Create a POV-Ray tube object.

Return value

1 for success, 0 for failure

Keywords

open

set to control whether the ends are open or closed

radius

radius of the cones; either a scalar or a fltarr(n) where there are n points in the polyline; default value is 1.0

finish
no_shadow
_extra

top visgrpovraytubes__define

visgrpovraytubes__define

Define instance variables.

File attributes

Modification date: Wed Jun 29 12:12:14 2011
Lines: 267
Docformat: rst rst