MG Library

Library of Michael Galloy

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

objectgraphics/

mggrellipsoid__define.pro

Class description for mggrellipsoid

Inheritance

All ancestor classes: IDLGRMODEL IDLGRCONTAINER IDL_CONTAINER IDLGRCOMPONENT IDLITCOMPONENT

Properties

_extra set init
pobj get
parent set
radius get set init
_ref_extra get
density get set init
tex_coords init
pos get set init

Fields

oPoly obj_new()

IDLgrPolygon object containing verts and conn of the ellipsoid

radius [0.00000, 0.00000, 0.00000]

floating point numbers representing the radius of the ellipsoid (measured in data units) in the x-, y-, and z-directions

density 0.00000

value representing the density at which the vertices should be generated along the surface of the orb

texture 0S

boolean for whether texture coordinates are needed for the ellipsoid

pos [0.00000, 0.00000, 0.00000]

position of the center of the ellipsoid

Fields in IDLGRMODEL

Fields in IDLGRCONTAINER

Fields in IDL_CONTAINER

Fields in IDLGRCOMPONENT

Fields in IDLITCOMPONENT

Routines

mggrellipsoid::setProperty [, pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, parent=parent] [, _extra=keywords]

Set properties of the ellipsoid.

mggrellipsoid::getProperty [, pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, pobj=object] [, _ref_extra=keywords]

Get properties of the ellipsoid.

mggrellipsoid::print

Prints position, radius, and density of the ellipsoid for debugging purposes.

mggrellipsoid::buildPoly

Sets the vertex and connectivity arrays for the polygon used to represent the orb.

mggrellipsoid::cleanup

Free resources.

result = mggrellipsoid::init( [pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, tex_coords=tex_coords] [, _extra=keywords])

Initialize ellipsoid.

mggrellipsoid__define

Define member variables.

Routine details

topmggrellipsoid::setProperty

mggrellipsoid::setProperty [, pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, parent=parent] [, _extra=keywords]

Set properties of the ellipsoid.

Keywords

pos in optional type=fltarr(3)

A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units

radius in optional type=fltarr(3)

a floating point number representing the radius of the ellipsoid (measured in data units) in the x-, y-, and z-directions

density in optional type=float

A floating point number representing the density at which the vertices should be generated along the surface of the orb

parent in optional

not used, included only for compatibility to Orb class

_extra in optional type=keywords

keywords to IDLgrModel::setProperty or IDLgrPolygon::setProperty

topmggrellipsoid::getProperty

mggrellipsoid::getProperty [, pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, pobj=object] [, _ref_extra=keywords]

Get properties of the ellipsoid.

Keywords

pos out optional type=fltarr(3)

set to a named variable to get a three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units

radius out optional type=fltarr(3)

set to a named variable to get a floating point number representing the radius of the ellipsoid (measured in data units) in the x-, y-, and z-directions

density out optional type=float

set to a named variable to get a floating point number representing the density at which the vertices should be generated along the surface of the orb

pobj out optional type=object

set to a named variable to get a IDLgrPolygon reference for the ellipsoid verts and conn

_ref_extra out optional type=keywords

keywords to IDLgrPolygon::getProperty or IDLgrModel::getProperty

topmggrellipsoid::print

mggrellipsoid::print

Prints position, radius, and density of the ellipsoid for debugging purposes.

topmggrellipsoid::buildPoly

mggrellipsoid::buildPoly

Sets the vertex and connectivity arrays for the polygon used to represent the orb.

topmggrellipsoid::cleanup

mggrellipsoid::cleanup

Free resources.

topmggrellipsoid::init

result = mggrellipsoid::init( [pos=fltarr(3)] [, radius=fltarr(3)] [, density=float] [, tex_coords=tex_coords] [, _extra=keywords])

Initialize ellipsoid.

Return value

1 for success, 0 for failure

Keywords

pos in optional type=fltarr(3) default=[0.0, 0.0, 0.0]

A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units

radius in optional type=fltarr(3)

{default=[1.0, 1.0, 1.0] floating point numbers representing the radius of the ellipsoid (measured in data units) in the x-, y-, and z-directions

density in optional type=float default=1.0

A floating point number representing the density at which the vertices should be generated along the surface of the orb

tex_coords in optional

{type=boolean) set this keyword to a nonzero value if texture map coordinates are to be generated for the orb

_extra in optional type=keywords

keywords to IDLgrModel::init

topmggrellipsoid__define

mggrellipsoid__define

Define member variables.

File attributes

Modification date: Tue Nov 20 11:24:27 2007
Lines: 298