vis/objectgraphics/
mggrellipsoid__define.pro
object graphics
includes main-level programClass representing an ellipse.
Examples
See the main-level example program at the end of this file:
IDL> .run mggrellipsoid__define
Class description for mggrellipsoid
Inheritance
- IDLGRMODEL
All ancestor classes: IDLGRMODEL IDLGRCONTAINER IDL_CONTAINER IDLGRCOMPONENT IDLITCOMPONENT
Properties
Properties in mggrellipsoid
- _extra set init type=keywords
keywords to IDLgrModel::setProperty or IDLgrPolygon::setProperty
- _ref_extra get
- density get set init type=float
A floating point number representing the density at which the vertices should be generated along the surface of the orb
- parent set type=object
not used, included only for compatibility to Orb class
- pobj get type=object
underlying polygon object
- pos get set init type=fltarr(3)
A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units
- radius get set init type=fltarr(3)
a floating point number representing the radius of the ellipsoid (measured in data units) in the x-, y-, and z-directions
- tex_coords init type=boolean
set this keyword to a nonzero value if texture map coordinates are to be generated for the orb
Routines
Routines from mggrellipsoid__define.pro
mggrellipsoid::setProperty, pos=fltarr(3), radius=fltarr(3), density=float, parent=object, _extra=keywordsSet properties of the ellipsoid.
mggrellipsoid::getProperty, pos=fltarr(3), radius=fltarr(3), density=float, pobj=object, _ref_extra=_ref_extraGet properties of the ellipsoid.
mggrellipsoid::printPrints position, radius, and density of the ellipsoid for debugging purposes.
mggrellipsoid::_buildPolySets the vertex and connectivity arrays for the polygon used to represent the orb.
mggrellipsoid::cleanupFree resources.
result = mggrellipsoid::init(pos=fltarr(3), radius=fltarr(3), density=float, /tex_coords, _extra=keywords)Initialize ellipsoid.
mggrellipsoid__defineDefine member variables.
Routine details
top mggrellipsoid::setProperty
mggrellipsoid::setProperty, pos=fltarr(3), radius=fltarr(3), density=float, parent=object, _extra=keywords
Set properties of the ellipsoid.
Keywords
- pos type=fltarr(3)
A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units
- radius 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 type=float
A floating point number representing the density at which the vertices should be generated along the surface of the orb
- parent type=object
not used, included only for compatibility to Orb class
- _extra type=keywords
keywords to IDLgrModel::setProperty or IDLgrPolygon::setProperty
top mggrellipsoid::getProperty
mggrellipsoid::getProperty, pos=fltarr(3), radius=fltarr(3), density=float, pobj=object, _ref_extra=_ref_extra
Get properties of the ellipsoid.
Keywords
- pos type=fltarr(3)
A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units
- radius 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 type=float
A floating point number representing the density at which the vertices should be generated along the surface of the orb
- pobj type=object
underlying polygon object
- _ref_extra
top mggrellipsoid::print
mggrellipsoid::print
Prints position, radius, and density of the ellipsoid for debugging purposes.
top mggrellipsoid::_buildPoly
mggrellipsoid::_buildPoly
Sets the vertex and connectivity arrays for the polygon used to represent the orb.
top mggrellipsoid::init
result = mggrellipsoid::init(pos=fltarr(3), radius=fltarr(3), density=float, /tex_coords, _extra=keywords)
Initialize ellipsoid.
Return value
1 for success, 0 for failure
Keywords
- pos type=fltarr(3)
A three-element vector, [x, y, z], specifying the position of the center of the ellipsoid, measured in data units
- radius 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 type=float
A floating point number representing the density at which the vertices should be generated along the surface of the orb
- tex_coords type=boolean
set this keyword to a nonzero value if texture map coordinates are to be generated for the orb
- _extra type=keywords
keywords to IDLgrModel::setProperty or IDLgrPolygon::setProperty
File attributes
| Modification date: | Wed May 14 15:07:15 2014 |
| Lines: | 169 |
| Docformat: | rst rst |
Contact me if you have enhancement requests or bug fixes.