[Previous]
[Next]
NAME:
IBETA
PURPOSE:
This function computes the incomplete beta function, Ix(a, b).
CATEGORY:
Special Functions.
CALLING SEQUENCE:
Result = IBETA(A, B, X)
INPUTS:
A: A scalar or array that specifies the parametric exponent of the
integrand. A may be real or complex.
B: A scalar or array that specifies the parametric exponent of the
integrand. A may be real or complex.
X: A scalar or array that specifies the upper limit of integration.
X may be real or complex. If X is real, and is outside of the
range [0,1] then the result is complex.
KEYWORD PARAMETERS:
DOUBLE = Set this keyword to force the computation to be done
in double precision.
EPS = relative accuracy, or tolerance. The default tolerance
is 3.0e-7 for single precision, and 3.0d-12 for double
precision.
ITER = Set this keyword equal to a named variable that will contain
the actual number of iterations performed.
ITMAX = Set this keyword to specify the maximum number of iterations.
The default value is 100.
CALLS: ***
IBETACF, IBETACF_TRUNCATE
CALLED BY:
FV_TEST, F_PDF, R_CORRELATE, TM_TEST, T_PDF
EXAMPLE:
Compute the incomplete beta function for the corresponding elements
of A, B, and X.
Define the parametric exponents.
A = [0.5, 0.5, 1.0, 5.0, 10.0, 20.0]
B = [0.5, 0.5, 0.5, 5.0, 5.0, 10.0]
Define the the upper limits of integration.
X = [0.01, 0.1, 0.1, 0.5, 1.0, 0.8]
Compute the incomplete beta functions.
result = Ibeta(A, B, X)
The result should be:
[0.0637686, 0.204833, 0.0513167, 0.500000, 1.00000, 0.950737]
REFERENCE:
Numerical Recipes, The Art of Scientific Computing (Second Edition)
Cambridge University Press
ISBN 0-521-43108-5
MODIFICATION HISTORY:
Written by: GGS, RSI, September 1994
IBETA is based on the routines: betacf.c, betai.c and
gammln.c described in section 6.2 of Numerical Recipes,
The Art of Scientific Computing (Second Edition), and is
used by permission.
Modified by:
CT, RSI, March 2000, added DOUBLE, EPS, ITER, ITMAX keywords.
CT, RSI, Dec 2001: Converted to allow complex inputs,
change to vector algorithm.
CT, RSI, Sept 2003: Improve calc to allow huge A and B values.
[Previous]
[Next]
NAME:
iContour
PURPOSE:
Implements the icontour wrapper interface for the tools sytem.
CALLING SEQUENCE:
IContour
INPUTS:
Z[,X,Y] [,...] (see IDLgrContour)
KEYWORD PARAMETERS:
IDENTIFIER [out] - The identifier of the created tool.
RGB_TABLE
Set this keyword to either a 3x256 or 256x3 array containing
color values to use for vertex colors.
RGB_INDICES
Set this keyword to a vector of indices into the color table
to select colors to use for vertex colors. If the number of
colors selected is less than the number of vertices, the
colors are repeated cyclically.
All other keywords are passed to the tool during creation.
CALLS: ***
IDLitsys_CreateTool
CALLED BY:
iMap [1]
MODIFICATION HISTORY:
Written by: Alan, RSI, January 2003
Modified:
[Previous]
[Next]
NAME:
iDataManager
PURPOSE:
Launches the DataManager
CALLING SEQUENCE:
iDataManager
INPUTS:
None
KEYWORD PARAMETERS:
None
CALLS: ***
_IDLitsys_GetSystem
MODIFICATION HISTORY:
Written by: AGEH, RSI, November 2003
[Previous]
[Next]
NAME:
IDENTITY
PURPOSE:
This function returns an N by N identity array, an array with
ones along the main diagonal and zeros elsewhere.
CATEGORY:
Linear Algebra.
CALLING SEQUENCE:
Result = IDENTITY(N)
INPUTS:
N: The desired column and row dimensions.
KEYWORD PARAMETERS:
DOUBLE: If set to a non-zero value, a double precision identity array
is returned.
CALLED BY:
CW_LIGHT_EDITOR, IDLexModelManip, IDLexObjview, IDLitManipROIDefine
MATRIX_POWER, _idlitvisualization__define [10]
_idlitvisualization__define [11], _idlitvisualization__define [12]
_idlitvisualization__define [13], _idlitvisualization__define [14]
_idlitvisualization__define [15], _idlitvisualization__define [16]
_idlitvisualization__define [17], _idlitvisualization__define [18]
_idlitvisualization__define [19], _idlitvisualization__define [1]
_idlitvisualization__define [20], _idlitvisualization__define [21]
_idlitvisualization__define [22], _idlitvisualization__define [23]
_idlitvisualization__define [24], _idlitvisualization__define [25]
_idlitvisualization__define [26], _idlitvisualization__define [27]
_idlitvisualization__define [28], _idlitvisualization__define [29]
_idlitvisualization__define [2], _idlitvisualization__define [30]
_idlitvisualization__define [31], _idlitvisualization__define [32]
_idlitvisualization__define [33], _idlitvisualization__define [34]
_idlitvisualization__define [35], _idlitvisualization__define [36]
_idlitvisualization__define [37], _idlitvisualization__define [38]
_idlitvisualization__define [39], _idlitvisualization__define [3]
_idlitvisualization__define [40], _idlitvisualization__define [41]
_idlitvisualization__define [42], _idlitvisualization__define [43]
_idlitvisualization__define [44], _idlitvisualization__define [45]
_idlitvisualization__define [46], _idlitvisualization__define [47]
_idlitvisualization__define [48], _idlitvisualization__define [49]
_idlitvisualization__define [4], _idlitvisualization__define [50]
_idlitvisualization__define [51], _idlitvisualization__define [52]
_idlitvisualization__define [53], _idlitvisualization__define [54]
_idlitvisualization__define [55], _idlitvisualization__define [56]
_idlitvisualization__define [57], _idlitvisualization__define [5]
_idlitvisualization__define [6], _idlitvisualization__define [7]
_idlitvisualization__define [8], _idlitvisualization__define [9]
idlitmaniproi__define [10], idlitmaniproi__define [1]
idlitmaniproi__define [2], idlitmaniproi__define [3]
idlitmaniproi__define [4], idlitmaniproi__define [5]
idlitmaniproi__define [6], idlitmaniproi__define [7]
idlitmaniproi__define [8], idlitmaniproi__define [9]
idlitopmacrorotate__define, idlitvisaxis__define [1]
idlitvisaxis__define [2], idlitvisdataspace__define [10]
idlitvisdataspace__define [11], idlitvisdataspace__define [12]
idlitvisdataspace__define [13], idlitvisdataspace__define [14]
idlitvisdataspace__define [15], idlitvisdataspace__define [16]
idlitvisdataspace__define [17], idlitvisdataspace__define [18]
idlitvisdataspace__define [19], idlitvisdataspace__define [1]
idlitvisdataspace__define [20], idlitvisdataspace__define [2]
idlitvisdataspace__define [3], idlitvisdataspace__define [4]
idlitvisdataspace__define [5], idlitvisdataspace__define [6]
idlitvisdataspace__define [7], idlitvisdataspace__define [8]
idlitvisdataspace__define [9], idlitvislight__define [1]
idlitvislight__define [2], idlitvislight__define [3]
idlitvislight__define [4], idlitvislight__define [5]
idlitvislight__define [6]
EXAMPLE:
Define an array, A.
A = [[ 2.0, 1.0, 1.0, 1.5], $
[ 4.0, -6.0, 0.0, 0.0], $
[-2.0, 7.0, 2.0, 2.5], $
[ 1.0, 0.5, 0.0, 5.0]]
Compute the inverse of A using the INVERT function.
Inverse = INVERT(A)
Verify the accuracy of the computed inverse using the mathematical
identity, A x A^-1 - I(4) = 0; where A^-1 is the inverse of A, I(4)
is the 4 by 4 identity array and 0 is a 4 by 4 array of zeros.
PRINT, A ## Inverse - IDENTITY(4)
REFERENCE:
ADVANCED ENGINEERING MATHEMATICS (seventh edition)
Erwin Kreyszig
ISBN 0-471-55380-8
MODIFICATION HISTORY:
Written by: GGS, RSI, January 1996
[Previous]
[Next]
NAME:
IDL_CRANK
PURPOSE:
Replace elements of the sorted array "w" by their rank.
Identical observations ("ties") return the mean rank.
NOTE: This procedures is not a supported user-level routine.
It is a support routine for IDL statistics library functions.
CATEGORY:
Analysis
CALLING SEQUENCE:
IDL_CRANK, W
INPUTS:
W: A sorted array
OUTPUTS:
W: IDL_CRANK replaces the input array W with its floating point
rank.
OPTIONAL OUTPUTS:
s = total(f^3 - f)
(f is the number of elements in each set of identical observations.)
CALLED BY:
KW_TEST, RS_TEST, R_CORRELATE
EXAMPLE:
X = [-1, 2, 3, 5, 6, 6, 9]
IDL_CRANK, X
produces
X = [1.000, 2.000, 3.000, 4.000, 5.500, 5.500, 6.000 ]
MODIFICATION HISTORY:
Tue Jan 27 16:50:31 1998, Scott Lett, RSI, Adapted from
earlier IDL library routines.
[Previous]
[Next]
NAME:
IDLexInscribingView
PURPOSE:
Provide a type of IDLgrView that has convenient methods for
defining the view volume and eyepoint, and getting viewport
dimensions. By default, this class's method to define the
view volume, "SetViewVolume", defines the view volume such
that the volume inscribes the view's contents. Hence the
class name: "IDLexInscribingView."
CALLS: ***
GET_OBJ_RANGE, IDLEXINSCRIBINGVIEW::GETBOUNDS
IDLEXINSCRIBINGVIEW::GETVIEWPORTDIMENSIONS, IDLEXINSCRIBINGVIEW::INIT
IDLEXINSCRIBINGVIEW::PADVIEWPLANERECT, IDLEXINSCRIBINGVIEW::SETEYE
IDLEXINSCRIBINGVIEW::SETPROPERTY, IDLEXINSCRIBINGVIEW::SETVIEWVOLUME
IDLEXINSCRIBINGVIEW::ZOOMVIEWPLANERECT, IDLEXINSCRIBINGVIEW__DEFINE
[Previous]
[Next]
NAME:
IDLexModelManip
PURPOSE:
This object serves to simplify dynamic manipulation of the
transformation matrix of an IDLgrModel object.
CATEGORY:
Object graphics examples.
CALLING SEQUENCE:
oMm = OBJ_NEW('IDLexModelManip')
IDLexModelManip::MouseTrack, pos, oDest
IDLexModelManip::MouseUp, pos, oDest
IDLexModelManip::MouseDown, [event.x, event.y], oDest
IDLexModelManip::SetTarget, oTarget, oDest, _extra=e
IDLexModelManip::Undo -- undo manipulation
IDLexModelManip::SetProperty
IDLexModelManip::GetProperty
TARGET - The IDLgrModel Object currently being manipulated (GET only)
MODE - The manipulation mode (0=translation,1=rotation,2=scale)
TWO_D - Set if the visuals should be 2D instead of 3D
MANIP_SHOW_SEL - True if the selection visual is to be displayed
MANIP_SHOW_MANIP - True if the manipulation visual is to be displayed
TRANSLATE - Set to a 3 element binary vector. Element is true if
translation along that axis is to be allowed. Axes are with
respect to self's orientation. Note: the default is no
translation, i.e [0b,0b,0b]. Set or initialize this property
to a value other than the default to allow translation.
CONSTRAIN_REF_PT - Reference point for constrained translation
CONSTRAIN_TRANS - True if constrained translation is in effect
CONSTRAIN_XRANGE - Limits of translation in X [min,max]
CONSTRAIN_YRANGE - Limits of translation in Y [min,max]
CONSTRAIN_ZRANGE - Limits of translation in Z [min,max]
KEYWORD PARAMETERS:
IDLexModelManip::Init:
CALLS: ***
CROSSP, IDENTITY, IDLEXMODELMANIP::BUILD_MANIP_VISUAL
IDLEXMODELMANIP::CLEANUP, IDLEXMODELMANIP::GETPROPERTY
IDLEXMODELMANIP::GET_VIEW, IDLEXMODELMANIP::INIT, IDLEXMODELMANIP::MOUSEDOWN
IDLEXMODELMANIP::MOUSETRACK, IDLEXMODELMANIP::MOUSEUP
IDLEXMODELMANIP::SETPROPERTY, IDLEXMODELMANIP::SETTARGET
IDLEXMODELMANIP::UNDO, IDLEXMODELMANIP::V_TO_DATA, IDLEXMODELMANIP__DEFINE
IDLEXMODELMANIP__GET_BOUNDS, IDLEXMODELMANIP__QUATERNION_M3
MODIFICATION HISTORY:
Written by: RJF, Nov 1996
[Previous]
[Next]
NAME:
IDLexObjview
PURPOSE:
Provide a subclass of IDLexInscribingView that contains a hierarchy
of models dedicated to various types of transformations. The
transformations can be updated via an Update method that can
be passed mouse events. Also, via certain models in the hierarchy,
subjects in this view are automatically centered about the origin
when self's view volume is set via self->SetViewVolume.
Default stationary lights are created and added if none are
supplied by the user.
This class is deployed by the XOBJVIEW command.
CREATION AND USE:
oView = obj_new('IDLexObjview')
oView->Add, oObj
oObj is a reference to an atomic graphics object or to an
IDLgrModel. oObj can be an array of such references.
If non-default lights (or other stationary objects) are desired:
oView->Add, oObj, /stationary
As in the previous example, oObj is a reference to an atomic
graphics object, a reference to an IDLgrModel, or an array
of such references. In this example, if oObj is, or contains,
one or more IDLgrLights then the view's default lights
are overridden.
CALLS: ***
GET_OBJ_RANGE, IDENTITY, IDLEXOBJVIEW::ADD, IDLEXOBJVIEW::CALCRANGES
IDLEXOBJVIEW::CLEANUP, IDLEXOBJVIEW::COUNT, IDLEXOBJVIEW::GET
IDLEXOBJVIEW::GETBOUNDS, IDLEXOBJVIEW::GETPROPERTY, IDLEXOBJVIEW::INIT
IDLEXOBJVIEW::ISCONTAINED, IDLEXOBJVIEW::MOVE, IDLEXOBJVIEW::NORMALIZE
IDLEXOBJVIEW::RAKEHEAP, IDLEXOBJVIEW::REMOVE, IDLEXOBJVIEW::RESET
IDLEXOBJVIEW::ROTATE, IDLEXOBJVIEW::SETPROPERTY, IDLEXOBJVIEW::TRANSLATE
IDLEXOBJVIEW::UPDATE, IDLEXOBJVIEW::ZOOM, IDLEXOBJVIEW__CONTAINS_LIGHTS
IDLEXOBJVIEW__DEFINE, REVERSE
EXAMPLE:
See procedure IDLexObjview__example in file idlexobjview__define.pro.
Also see xobjview.pro.
[Previous]
[Next]
NAME:
IDLexViewGroup
PURPOSE:
Provide a subclass of IDLgrViewgroup that maintains the notion of a
"current" child, provides methods for operating on that child,
and has other convenience methods for printing, exporting to VRML, etc.
CREATION:
oViewGroup = obj_new('IDLexViewGroup')
CALLS: ***
DIALOG_WRITE_IMAGE, IDLEXVIEWGROUP::ADD, IDLEXVIEWGROUP::CALLALL
IDLEXVIEWGROUP::CALLCURRENT, IDLEXVIEWGROUP::CALLCURRENT
IDLEXVIEWGROUP::COPYTOCLIPBOARD, IDLEXVIEWGROUP::DIALOGPRINT
IDLEXVIEWGROUP::DIALOGWRITEIMAGE, IDLEXVIEWGROUP::DIALOGWRITEVRML
IDLEXVIEWGROUP::GET, IDLEXVIEWGROUP::GETPROPERTY, IDLEXVIEWGROUP::INIT
IDLEXVIEWGROUP::REMOVE, IDLEXVIEWGROUP::SETCURRENT
IDLEXVIEWGROUP::SETPROPERTY, IDLEXVIEWGROUP::WRITEIMAGE
IDLEXVIEWGROUP__DEFINE, WRITE_IMAGE
[Previous]
[Next]
NAME:
IDLexViewManip
PURPOSE:
This object serves to simplify dynamic manipulation of the
position and size of an IDLgrView object within a destination
object.
CATEGORY:
Object graphics examples.
CALLING SEQUENCE:
oVm = OBJ_NEW('IDLexViewManip')
IDLexViewManip::SetProperty
IDLexViewManip::GetProperty
IDLexViewManip::MouseUp, mouseXY, oDest
IDLexViewManip::MouseTrack, mouseXY, oDest
IDLexViewManip::MouseDown, mouseXY, oDest
IDLexViewManip::Reshape
IDLexViewManip::SetTarget, oView, oDest
KEYWORD PARAMETERS:
IDLexViewManip::Init:
CALLS: ***
IDLEXVIEWMANIP::BUILD_VISUALS, IDLEXVIEWMANIP::CALCRECT
IDLEXVIEWMANIP::CLEANUP, IDLEXVIEWMANIP::GETPROPERTY, IDLEXVIEWMANIP::INIT
IDLEXVIEWMANIP::MOUSEDOWN, IDLEXVIEWMANIP::MOUSETRACK
IDLEXVIEWMANIP::MOUSEUP, IDLEXVIEWMANIP::RESHAPE
IDLEXVIEWMANIP::SETPROPERTY, IDLEXVIEWMANIP::SETTARGET
IDLEXVIEWMANIP__DEFINE
MODIFICATION HISTORY:
Written by: RJF, Nov 1996
[Previous]
[Next]
CLASS_NAME:
IDLffLangCat
PURPOSE:
An IDLffLangCat object provides an interface to IDL language
catalog files.
CATEGORY:
Internationalization
SUPERCLASSES:
This class has no superclasses.
IDLffLangCat_AppName inherits from IDLffXMLSAX.
SUBCLASSES:
This class has no subclasses.
CREATION:
See IDLffLangCat::Init
METHODS:
IDLffLangCat::Cleanup
IDLffLangCat::DefineMessageBlock
IDLffLangCat::Query
IDLffLangCat::GetProperty
IDLffLangCat::SetProperty
IDLffLangCat::AppendCatalog
IDLffLangCat::_GetApplicationFiles
IDLffLangCat::_Load
IDLffLangCat::Init
IDLffLangCat_Appname::Init
IDLffLangCat_Appname::GetAppName
IDLffLangCat_Appname::Error
IDLffLangCat_Appname::FatalError
IDLffLangCat_Appname::StartElement
IDLffLangCat_Show_Error
IDLffLangCat_Swallow_Error
CALLS: ***
FILEPATH, IDLFFLANGCAT::APPENDCATALOG, IDLFFLANGCAT::CLEANUP
IDLFFLANGCAT::DEFINEMESSAGEBLOCK, IDLFFLANGCAT::GETPROPERTY
IDLFFLANGCAT::INIT, IDLFFLANGCAT::QUERY, IDLFFLANGCAT::SETPROPERTY
IDLFFLANGCAT::_GETAPPLICATIONFILES, IDLFFLANGCAT::_GETAPPLICATIONNAMES
IDLFFLANGCAT::_LOAD, IDLFFLANGCAT::_STRREPLACE, IDLFFLANGCAT_APPNAME::ERROR
IDLFFLANGCAT_APPNAME::FATALERROR, IDLFFLANGCAT_APPNAME::GETAPPNAME
IDLFFLANGCAT_APPNAME::INIT, IDLFFLANGCAT_APPNAME::STARTELEMENT
IDLFFLANGCAT_APPNAME__DEFINE, IDLFFLANGCAT_SHOW_ERROR
IDLFFLANGCAT_SWALLOW_ERROR, PATH_SEP, UNIQ
MODIFICATION HISTORY:
Created by: AGEH, December 2003
[Previous]
[Next]
NAME:
IDLgrArc
PURPOSE:
This object serves as a graphical representation of a Circle,
Arc, or Ellipse, which subclasses from the IDLgr?? class.
CATEGORY:
Object graphics.
CALLING SEQUENCE:
To initially create:
oArc = OBJ_NEW('IDLgrArc')
To retrieve a property value:
oArc->GetProperty
To set a property value:
oArc->SetProperty
To print to the standard output stream the current properties of
the Arc:
oArc->Print
To destroy:
OBJ_DESTROY, oArc
KEYWORD PARAMETERS:
ARC::INIT:
<Note that keywords accepted by IDLgrModel::Init and/or
IDLgrPolyline::Init are also accepted here.>
ASPECT: A floating point number representing the ratio of the
minor axis length to the major axis length of the Arc.
The default is 1.0.
DENSITY: A floating point number representing the density at which
the vertices should be generated along the path of the
Arc. The default is 1.0.
END_ANGLE: A floating point value representing the angle (measured
in degrees) at which the Arc should end. The default is 0.0.
NORMAL: A three-element floating point vector representing the
normal vector for the plane on which the arc should lie.
The default is [0,0,1].
POS: A three-element vector, [x,y,z], specifying the position
of the center of the Arc, measured in data units .
Defaults to [0,0,0].
RADIUS: A floating point number representing the radius of the
Arc (measured in data units). The default is 1.0.
START_ANGLE: A floating point value representing the angle (measured
in degrees) at which the Arc should start. The default is 0.0.
TILT: A floating point value representing the angle (measured in
degrees) by which the major axis of the arc is to be rotated.
The default is 0.
ARC::GETPROPERTY:
ALL: Set this keyword to a named variable that upon return will
contain an anonymous structure containing the values of all
of the properties associated with the Arc.
ASPECT: Set this keyword to a named variable that upon return will
contain a floating point number representing the ratio of the
minor axis length to the major axis length of the Arc.
DENSITY: Set this keyword to a named variable that upon return will
contain a floating point number representing the density at
which the vertices are generated along the path of the
Arc.
END_ANGLE: Set this keyword to a named variable that upon return will
contain a floating point number representing the angle
(measured in degrees) at which the Arc ends.
NORMAL: Set this keyword to a named variable that upon return will
contain a three-element floating point vector representing
the normal vector for the plane on which the arc lies.
POS: Set this keyword to a named variable that upon return will
contain a three-element vector, [x,y,z], specifying the
position of the center of the Arc, measured in data units .
RADIUS: Set this keyword to a named variable that upon return will
contain a floating point number representing the radius of the
Arc (measured in data units).
START_ANGLE: Set this keyword to a named variable that upon return
will contain a floating point number representing the angle
(measured in degrees) at which the Arc begins.
TILT: Set this keyword to a name variable that upon return will
contain a floating point number representing the angle
(measured in degrees) by which the major axis of the arc is
rotated.
ARC::SETPROPERTY:
<Note that keywords accepted by IDLgrModel::SetProperty and/or
IDLgrPolyline::SetProperty are also accepted here.>
ASPECT: A floating point number representing the ratio of the
minor axis length to the major axis length of the Arc.
The default is 1.0.
DENSITY: A floating point number representing the density at which
the vertices should be generated along the path of the
Arc. The default is 1.0.
END_ANGLE: A floating point value representing the angle (measured
in degrees) at which the Arc should end. The default is 0.0.
NORMAL: A three-element floating point vector representing the
normal vector for the plane on which the arc should lie.
The default is [0,0,1].
POS: A three-element vector, [x,y,z], specifying the position
of the center of the Arc. Defaults to [0,0,0].
RADIUS: A floating point number representing the radius of the
Arc (measured in data units). The default is 1.0.
START_ANGLE: A floating point value representing the angle (measured
in degrees) at which the Arc should start. The default is 0.0.
TILT: A floating point value representing the angle (measured in
degrees) by which the major axis of the arc is to be rotated.
The default is 0.
CALLS: ***
IDLGRARC::BUILDPOLY, IDLGRARC::CLEANUP, IDLGRARC::GETPROPERTY, IDLGRARC::INIT
IDLGRARC::PRINT, IDLGRARC::SETPROPERTY, IDLGRARC__DEFINE
EXAMPLE:
Create a circle centered at the origin with a radius of 0.5:
oCircle = OBJ_NEW('IDLgrArc', POS=[0,0,0], RADIUS=0.5)
MODIFICATION HISTORY:
Written by: DMS, July 2000.
[Previous]
[Next]
CLASS_NAME:
IDLgrColorbar
PURPOSE:
An IDLgrColorbar object consists of a color-ramp with an
optional framing box and annotation axis.
CATEGORY:
Graphics
SUPERCLASSES:
This class inherits from IDLgrModel.
SUBCLASSES:
This class has no subclasses.
CREATION:
See IDLgrColorbar::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLgrColorbar::Cleanup
IDLgrColorbar::Init
IDLgrColorbar::GetProperty
IDLgrColorbar::SetProperty
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::Init
PURPOSE:
The IDLgrColorbar::Init function method initializes the
colorbar object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oColorbar = OBJ_NEW('IDLgrColorbar' [,aRed, aGreen, aBlue])
or
Result = oColorbar->[IDLgrColorbar::]Init([aRed, aGreen, aBlue])
OPTIONAL INPUTS:
aRed: A vector containing the red values for the colorbar.
These values should be within the range of
0 <= Value <= 255. The number of elements comprising
the aRed vector must not exceed 256.
aGeeen: A vector containing the green values for the colorbar.
These values should be within the range of
0 <= Value <= 255. The number of elements comprising
the aGreen vector must not exceed 256.
aBlue: A vector containing the blue values for the colorbar.
These values should be within the range of
0 <= Value <= 255. The number of elements comprising
the aBlue vector must not exceed 256.
If no data is provided, the color palette will default to a
256 entry greyscale ramp.
KEYWORD PARAMETERS:
BLUE_VALUES(Get,Set): A vector containing the blue values for
the colorbar. Setting this value is the same as
specifying the aBlue argument to the IDLgrColorbar::Init
method.
COLOR(Get,Set): Set this keyword to the color to be used as
the foreground color for the axis and outline box.
The color may be specified as a color lookup table index
or as an RGB vector. The default is [0,0,0].
DIMENSIONS(Get,Set): Set this keyword to a two element vector
[dx,dy] which specifies the size of the ramp display
(not the axis) in units. If dx > dy, the colorbar is
drawn horizontally with the axis placed below or above
the ramp box depending on the value of the SHOW_AXIS
property. If dx < dy, the colorbar is drawn vertically
with the axis placed to the right or left of the ramp
box depending on the value of the SHOW_AXIS property.
The default value is [16,256].
GREEN_VALUES(Get,Set): A vector containing the green values for
the colorbar. Setting this value is the same as
specifying the aGreen argument to the IDLgrColorbar::Init
method.
HIDE(Get,Set): Set this keyword to a boolean value to indicate
whether this object should be drawn. 0=Draw (default),
1 = Hide.
MAJOR(Get,Set): Set this keyword to an integer representing
the number of major tick marks. The default is -1,
specifying that IDL will compute the number of tick marks.
Setting MAJOR equal to zero suppresses major tick marks
entirely.
MINOR(Get,Set): Set this keyword to an integer representing
the number of minor tick marks. The default is -1,
specifying that IDL will compute the number of tick marks.
Setting MINOR equal to zero suppresses minor tick marks
entirely.
NAME(Get,Set): Set this keyword to a string representing the
name to be associated with this object. The default is
the null string, ''.
PALETTE(Get,Set): Set this keyword to an IDLgrPalette object
to define the color table for the colorbar.
RED_VALUES(Get,Set): A vector containing the red values for
the colorbar. Setting this value is the same as
specifying the aRed argument to the IDLgrColorbar::Init
method.
SHOW_AXIS(Get,Set): Set this keyword to an integer value
indicating whether the axis should be drawn. 0 = Do
not display axis (the default). 1 = Display axis on
left side or below the color ramp. 2 = Display axis on
right side or above the color ramp.
SHOW_OUTLINE(Get,Set): Set this keyword to a boolean value indicating
whether the colorbar bounds should be outlined.
0 = Do not display outline (the default). 1 = Display
outline.
SUBTICKLEN(Get,Set): Set this keyword to a scale ratio specifying
the length of minor tick marks relative to the length
of major tick marks. The default is 0.5, specifying
that the minor tick mark is one-half the length of the
major tick mark.
THICK(Get,Set): Set this keyword to an float value between 1
and 10, specifying the line thickness used to draw the
axis and outline box, in points. The default is 1.
THREED(Get): Set this keyword to indicate that the colorbar image
is to be implemented as a vertex colored surface to
allow the colorbar to be viewed in a true 3
dimensional space.
TICKFORMAT(Get,Set): Set this keyword to either a standard IDL
format string or a string containing the name of a user
supplied function that returns a string to be used to
format the axis tick mark labels. The function should
accept integer arguments for the direction of the axis,
the index of the tick mark, and the value of the tick
mark, and hsould return a string to be used as the tick
mark's label. The default is '', the null string, which
indicated that IDL will determine the appropriate format
for each value.
TICKFRMTDATA(Get,Set): Set this keyword to a value of any type.
If present, this value is passed via the keyword DATA to
any TICKFORMAT function the user may have set.
TICKLEN(Get,Set): Set this keyword to the length of each major
tick mark, measured in dimension units. The default
tick mark length is 8.
TICKTEXT(Get,Set): Set this keyword to either a single instance
of the IDLgrText object class (with multiple strings)
of to a vector of instances of the IDLgrText object
class (one per major tick) to specify the annotations
to be assigned to the tickmarks. By default, with
TICKTEXT set equal to a null object, IDL computes the
tick labels based on major tick values. The positions
of the provided text objects may be overwritten;
position is determined according to tick mark location.
TICKVALUES(Get,Set): Set this keyword to a vector of data values
representing the values at each tick mark.
TITLE(Get,Set): Set this keyword to an instance of the IDLgrText
object class to specify the title for the axis. The
default is the null object, specifying that no title is
drawn. The title will be centered along the axis, even
if the text object itself has an associated location.
UVALUE(Get,Set): Set this keyword to a value of any type. You
may use this value to contain any information you wish.
XCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the X coordinates to an alternate data space.
The formula for the conversion is as follows: converted
X = t+s*X. The default is [0,1].
YCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the Y coordinates to an alternate data space.
The formula for the conversion is as follows: converted
Y = t+s*Y. The default is [0,1].
ZCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the Z coordinates to an alternate data space.
The formula for the conversion is as follows: converted
Z = t+s*Z. The default is [0,1].
OUTPUTS:
1: successful, 0: unsuccessful.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
EXAMPLE:
oColorbar = OBJ_NEW('IDLgrColorbar')
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
Scott J. Lasica, 5/8/98
- Added the THREED keyword.
- Added the PALETTE keyword.
Modified: C. Torrence, 9/7/00:
- Disable LIGHTING for model.
- Fix position of box outline
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::ComputeDimensions
PURPOSE:
The IDLgrColorbar::ComputeDimensions method function
computes and returns the dimensions of the colorbar
for a given destination.
CALLING SEQUENCE:
Result = oColorbar->[IDLgrColorbar::]ComputeDimensions(SrcDest)
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 3/5/98
Modified: CT, RSI, Oct 2000
- Add support for colorbar-only
- Fix calc for long titles or ticktext
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::CalcSize
PURPOSE:
This method is intended to be private, and should never be called
directly.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::Cleanup
PURPOSE:
The IDLgrColorbar::Cleanup procedure method preforms all cleanup
on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, oColorbar
or
oColorbar->[IDLgrColorbar::]Cleanup
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::SetProperty
PURPOSE:
The IDLgrColorbar::SetProperty procedure method sets the value
of a property or group of properties for the colorbar.
CALLING SEQUENCE:
oColorbar->[IDLgrColorbar::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLgrColorbar::Init followed by the word "Set"
can be set using IDLgrColorbar::SetProperty.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
EXAMPLE:
oColorbar->SetProperty, THICK = 1
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrColorbar::GetProperty
PURPOSE:
The IDLgrColorbar::GetProperty procedure method retrieves the
value of a property or group of properties for the colorbar.
CALLING SEQUENCE:
oColorbar->[IDLgrColorbar::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLgrColorbar::Init followed by the word "Get"
can be retrieved using IDLgrColorbar::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
PARENT: Set this keyword to a named variable that will contain
an object reference to the object that contains this colorbar.
XRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [xmin,xmax] specifying
the range of the x data coordinates covered by the colorbar.
YRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [ymin,ymax] specifying
the range of the y data coordinates covered by the colorbar.
ZRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [zmin,zmax] specifying
the range of the z data coordinates covered by the colorbar.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
EXAMPLE:
myColorbar->GetProperty, PARENT = parent
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
----------------------------------------------------------------------------
IDLgrColorbar__Define
Purpose:
Defines the object structure for an IDLgrColorbar object.
CALLS: ***
CONGRID, IDLGRCOLORBAR::CALCSIZE, IDLGRCOLORBAR::CLEANUP
IDLGRCOLORBAR::COMPUTEDIMENSIONS, IDLGRCOLORBAR::GETPROPERTY
IDLGRCOLORBAR::INIT, IDLGRCOLORBAR::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/22/97
[Previous]
[Next]
CLASS_NAME:
IDLgrLegend
PURPOSE:
An IDLgrLegend object provides a simple interface for
displaying a list of glyph/box/styled line - text string
tuples. They are displayed in a single column (default)
with an optional title string and bounding box which can
be filled.
CATEGORY:
Graphics
SUPERCLASSES:
This class inherits from IDLgrModel.
SUBCLASSES:
This class has no subclasses.
CREATION:
See IDLgrLegend::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLgrLegend::Cleanup
IDLgrLegend::ComputeDimensions
IDLgrLegend::Init
IDLgrLegend::GetProperty
IDLgrLegend::SetProperty
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::Init
PURPOSE:
The IDLgrLegend::Init function method initializes the
legend object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLgrLegend'[,aItemNames])
or
Result = oLegend->[IDLgrLegend::]Init([aItemNames])
OPTIONAL INPUTS:
aItemNames - an array of strings to be used as the displayed
item labels. The length of this array is used to
determine the number of items to be displayed. Each
item is defined by taking one element from the
ITEM_NAME, ITEM_TYPE, ITEM_LINESTYLE, ITEM_THICK,
ITEM_COLOR and ITEM_OBJECT vectors. IF the number
of items (as defined by the ITEM_NAME array) exceeds
any of the attribute vectors, the attribute defaults
will be used for any additional items.
KEYWORD PARAMETERS:
BORDER_GAP(Get,Set): Set this keyword to a float value to indicate
the amount of blank space to be placed around the outside
of the glyphs and text items. The units for this keyword
are in fraction of the legend label font height. The
default is 0.1 (10% of the label font height).
COLUMNS(Get,Set): Set this keyword to an integer value to indicate
the number of columns the legend items should be displayed
in. The default is 1.
FILL_COLOR(Get,Set): Set this keyword to the color to be used
to fill the legend background box. The color may be
specified as a color lookup table index or as an RGB
vector. The default is [255,255,255].
FONT(Get,Set): Set this keyword to an instance of an IDLgrFont
object class to describe the font to use to draw the
legend labels. The default is 12 point Helvetica.
NOTE: If the default font is in use, retrieving the value
of the FONT property (using the GetProperty method)
will return a null object.
GAP(Get,Set): Set this keyword to a float value to indicate the
blank space to be placed vertically between each legend
item. The units for this keyword are in fraction of the
legend label font height. The default is 0.1 (10% of
the label font height). This same gap is placed
horizontally between the legend glyph and the legend
text string.
GLYPH_WIDTH(Get,Set): Set this keyword to a float value to
indicate the width of the glyphs. The units for this
keyword are a percentage of the font height. The
default value is .8 (80%).
HIDE(Get,Set): Set this keyword to a boolean value to indicate
whether this object should be drawn. 0=Draw (default),
1=Hide.
ITEM_COLOR(Get,Set): Set this keyword to an array of colors
defining the color of each item. This array can be of
the form [3,M] or [M] which defines M separate colors.
In the first case, the three values are used as an RGB
triplet, in the second case, the single value is used
as a color index value. The default color is: [0,0,0].
ITEM_LINESTYLE(Get,Set): Set this keyword to an array of integers
defining the style of the line to be drawn if the TYPE
is 0. The array can be of the form [M] or [2,M]. The
first form selects the linestyle for each legend item
from the predefined defaults:
0=Solid line (the default)
1=dotted
2=dashed
3=dash dot
4=dash dot dot dot
5=long dash
6=no line drawn
The second form specifies the stippling pattern explicity
for each legend item (see IDLgrPolyline::Init LINESTYLE
keyword for details).
ITEM_NAME(Get,Set): Set this keyword to an array of strings. This
keyword is the same as the aItemNames argument for the
IDLgrLegend::Init method.
ITEM_OBJECT(Get,Set): Set this keyword to an array of object
references. These can be objects of type IDLgrSymbol
or IDLgrPattern. A symbol object is drawn only if the
TYPE is 0. A pattern object is used when drawing the
color patch if the TYPE is 1. The default is the null
object.
ITEM_THICK(Get,Set): Set this keyword to an array of floats which
define the thickness of each item line (TYPE=0) in points.
The default is 1 point.
ITEM_TYPE(Get,Set): Set this keyword to an array of integers which
define the type of glyph to be displayed for each item.
0=line type (default), 1=filled box type.
NAME(Get,Set): Set this keyword to a string representing the name
to be associated with this object. The default is the
null string, ''.
OUTLINE_COLOR(Get,Set): Set this keyword to the color to be used
to draw the legend outline box. The color may be specified
as a color lookup table index or as an RGB vector. The
default is [0,0,0].
OUTLINE_THICK(Get,Set): Set this keyword to an integer which defines
the thickness of the legend outline box. Default = 1 point.
SHOW_OUTLINE(Get,Set): Set this keyword to a boolean value indicating
whether the outline box should be displayed. 0=Do not
display outline (default), 1=Display outline.
SHOW_FILL(Get,Set): Set this keyword to a boolean value indicating
whether the background should be filled with a color. 0=Do not
fill background (default), 1=fill background.
TEXT_COLOR(Get,Set): Set this keyword to the color to be used to
draw the legend item text. The color may be specified
as a color lookup table index or as an RGB vector. The
default is [0,0,0].
TITLE(Get,Set): Set this keyword to an instance of the IDLgrText
object class to specify the title for the legend. The
default is the null object, specifying that no title is
drawn. The title will be centered at the top of the
legend, even if the text object itself has an associated
location.
UVALUE(Get,Set): Set this keyword to a value of any type. You
may use this value to contain any information you wish.
XCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the X coordinates to an alternate data space.
The formula for the conversion is as follows:
converted X = t + s*X. The default is [0,1].
YCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the Y coordinates to an alternate data space.
The formula for the conversion is as follows:
converted Y = t + s*Y. The default is [0,1].
ZCOORD_CONV(Get,Set): Set this keyword to a vector, [t,s],
indicating the translation and scaling to be applied
to convert the Y coordinates to an alternate data space.
The formula for the conversion is as follows:
converted Y = t + s*Y. The default is [0,1].
OUTPUTS:
1: successful, 0: unsuccessful.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
EXAMPLE:
oLegend = OBJ_NEW('IDLgrLegend')
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::DefaultArrays
PURPOSE:
The IDLgrLegend::DefaultArrays procedure method is a private
method and is not intended to be called directly.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/30/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::CreateGlyphs
PURPOSE:
The IDLgrLegend::CreateGlyphs procedure method is a private
method and is not intended to be called directly.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/30/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::ComputeDimensions
PURPOSE:
The IDLgrLegend::ComputeDimensions method function
computes and returns the dimensions of the legend
for a given destination.
CALLING SEQUENCE:
Result = oLegend->[IDLgrLegend::]ComputeDimensions(SrcDest)
INPUTS:
SrcDest - A destination object.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
EXAMPLE:
dimensions = oLegend->ComputeDimensions(oSrcDest)
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 10/17/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::Draw
PURPOSE:
The IDLgrLegend::Draw procedure method is a private
method and is not to be called directly.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 10/1/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::Cleanup
PURPOSE:
The IDLgrLegend::Cleanup procedure method preforms all cleanup
on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, oLegend
or
oLegend->[IDLgrLegend::]Cleanup
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::SetProperty
PURPOSE:
The IDLgrLegend::SetProperty procedure method sets the value
of a property or group of properties for the legend.
CALLING SEQUENCE:
oLegend->[IDLgrLegend::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLgrLegend::Init followed by the word "Set"
can be set using IDLgrLegend::SetProperty.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
EXAMPLE:
myLegend->SetProperty, NAME = 'My Legend'
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
=============================================================
METHODNAME:
IDLgrLegend::GetProperty
PURPOSE:
The IDLgrLegend::GetProperty procedure method retrieves the
value of a property or group of properties for the legend.
CALLING SEQUENCE:
oLegend->[IDLgrLegend::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLgrLegend::Init or IDLgrModel::init followed by the
word "Get" can be retrieved using IDLgrLegend::GetProperty. In
addition the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
XRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [xmin,xmax] specifying
the range of the x data coordinates covered by the Legend.
YRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [ymin,ymax] specifying
the range of the y data coordinates covered by the Legend.
ZRANGE: Set this keyword to a named variable that will contain
a two-element vector of the form [zmin,zmax] specifying
the range of the z data coordinates covered by the Legend.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
EXAMPLE:
oLegend->GetProperty, PARENT = parent
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
----------------------------------------------------------------------------
IDLgrLegend__Define
Purpose:
Defines the object structure for an IDLgrLegend object.
CALLS: ***
IDLGRLEGEND::CLEANUP, IDLGRLEGEND::COMPUTEDIMENSIONS
IDLGRLEGEND::CREATEGLYPHS, IDLGRLEGEND::DEFAULTARRAYS, IDLGRLEGEND::DRAW
IDLGRLEGEND::GETPROPERTY, IDLGRLEGEND::INIT, IDLGRLEGEND::SETPROPERTY
MODIFICATION HISTORY:
Written by: Scott J. Lasica, 9/26/97
[Previous]
[Next]
CLASS_NAME:
IDLitAnnotateText
PURPOSE:
Abstract class for the manipulator system of the IDL component framework.
The class will not be created directly, but defines the basic
structure for the manipulator container.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CALLS: ***
IDLITANNOTATETEXT::FINISHANNOTATE, IDLITANNOTATETEXT::GETCURSORTYPE
IDLITANNOTATETEXT::INIT, IDLITANNOTATETEXT::ONKEYBOARD
IDLITANNOTATETEXT::ONLOSECURRENTMANIPULATOR
IDLITANNOTATETEXT::ONMOUSEDOWN, IDLITANNOTATETEXT::_GETCURRENTHERSHEYMODE
IDLITANNOTATETEXT::_ISNEXTHERSHEY, IDLITANNOTATETEXT::_ISPREVIOUSHERSHEY
IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitClipBoardItem
PURPOSE:
This object is used to record and maintain the state of an item
that is placed on the clipboard. The object is a sub-class of the
object descriptor class, which performs a majority of the items
needed for the system (repliction of objects).
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitObjDesc
SUBCLASSES:
CALLS: ***
IDLITCLIPBOARDITEM::ADDDATAPARAMETER, IDLITCLIPBOARDITEM::CLEANUP
IDLITCLIPBOARDITEM::CONTAINSBYVALUE, IDLITCLIPBOARDITEM::COPYITEM
IDLITCLIPBOARDITEM::GETPARAMETER, IDLITCLIPBOARDITEM::GETPARAMETERCOUNT
IDLITCLIPBOARDITEM::GETPARENTTYPES, IDLITCLIPBOARDITEM::GETPROPERTY
IDLITCLIPBOARDITEM::INIT, IDLITCLIPBOARDITEM::PASTEITEM
IDLITCLIPBOARDITEM::SETPROPERTY, IDLITCLIPBOARDITEM::_COPYITEMDATA
IDLITCLIPBOARDITEM::_SETPARENTTYPES, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitCommand
PURPOSE:
This file defines and implements the generic IDL tool command
object which is used to manage and store undo-redo
information.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitCommand::Init
METHODS:
INTERFACES:
IIDLProperty
CALLS: ***
IDLITCOMMAND::ADDITEM, IDLITCOMMAND::CLEANUP, IDLITCOMMAND::GETITEM
IDLITCOMMAND::GETPROPERTY, IDLITCOMMAND::GETSIZE, IDLITCOMMAND::INIT
IDLITCOMMAND::SETPROPERTY, IDLITCOMMAND::_RESETDATALIST, IDLITGETITEMSIZE
[Previous]
[Next]
CLASS_NAME:
IDLitCommandBuffer
PURPOSE:
This file implements the command undo-redo buffer of the IDL tools
system. The buffer is similar to a command set, but it maintains
the concept of a position and only executes on command on a undo
or redo operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
IDLitCommand
SUBCLASSES:
CREATION:
See IDLitCommandBuffer::Init
CALLS: ***
IDLITCOMMANDBUFFER::ADD, IDLITCOMMANDBUFFER::CLEANUP
IDLITCOMMANDBUFFER::COMMIT, IDLITCOMMANDBUFFER::DOREDO
IDLITCOMMANDBUFFER::DOUNDO, IDLITCOMMANDBUFFER::GETPROPERTY
IDLITCOMMANDBUFFER::GETSIZE, IDLITCOMMANDBUFFER::INIT
IDLITCOMMANDBUFFER::REMOVE, IDLITCOMMANDBUFFER::RESETBUFFER
IDLITCOMMANDBUFFER::ROLLBACK, IDLITCOMMANDBUFFER::SETPROPERTY
IDLITCOMMANDBUFFER::_DOTRANSACTION
IDLITCOMMANDBUFFER::_GETREDOTRANSACTION
IDLITCOMMANDBUFFER::_GETUNDOTRANSACTION
IDLITCOMMANDBUFFER::_NOTIFYUIUPDATES
IDLITCOMMANDBUFFER::_PRUNEBUFFERTOSIZE
IDLITCOMMANDBUFFER::_UNDOTRANSACTION, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitCommandSet
PURPOSE:
This file defines and implements the generic IDL tool command
object which is used to manage and store undo-redo
information. This object is primarly abstract, defining the
interfaces and workflow used in the tool command system.
For each action that is to be placed in the command system, a
specialized version of this object is needed. This is neccessary
so that the information/state that is needed for the particular
action is properly stored.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
IDLitCommand
SUBCLASSES:
CREATION:
See IDLitCommandSet::Init
METHODS:
INTERFACES:
IIDLProperty
IDL_Container
CALLS: ***
IDLITCOMMANDSET::ADD, IDLITCOMMANDSET::CLEANUP, IDLITCOMMANDSET::GETSIZE
IDLITCOMMANDSET::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitContainer
PURPOSE:
This file implements the IDLitContainer class. This class provides
a container that is aware of identifiers and uses these ids to find
and traverse the contents of the containment tree.
This traversal is all built off of the identifier property provided by
the IDLitComponent object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDL_Container
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitContainer::Init
METHODS:
This class has the following methods:
IDLitContainer::Init
IDLitContainer::Cleanup
INTERFACES:
IIDLProperty
IIDLContainer
CALLS: ***
IDLITCONTAINER::CLEANUP, IDLITCONTAINER::INIT
IDLITCONTAINER::QUERYAVAILABILITY
[Previous]
[Next]
METHODNAME:
IDLitData::AddDataObserver
PURPOSE:
The IDLitData::AddDataObserver procedure method adds the specified
observer object to this object's list of observers
CALLING SEQUENCE:
oData->[IDLitData::]AddDataObserver, oObserver
INPUTS:
oObserver - An IDL Component Data object that implements
the IIDLDataObserver interface
KEYWORD PARAMETERS:
OBSERVE_ONLY - If set, this object is just observing the state
of the object and should not be taken into
account as part of the auto_delete mechanism
CALLS: ***
IDLITDATA::ADDDATAOBSERVER, IDLITDATA::ADDMETADATA, IDLITDATA::CLEANUP
IDLITDATA::CLEARMETADATA, IDLITDATA::COPY, IDLITDATA::GETBYTYPE
IDLITDATA::GETDATA, IDLITDATA::GETDATAOBSERVERS, IDLITDATA::GETMETADATA
IDLITDATA::GETMETADATACOUNT, IDLITDATA::GETMETADATANAMES
IDLITDATA::GETPROPERTY, IDLITDATA::GETSIZE, IDLITDATA::GETTYPES
IDLITDATA::INIT, IDLITDATA::NOTIFYDATACHANGE, IDLITDATA::NOTIFYDATACOMPLETE
IDLITDATA::NOTIFYDATADELETE, IDLITDATA::REMOVEDATAOBSERVER
IDLITDATA::RESTORE, IDLITDATA::SETDATA, IDLITDATA::SETPROPERTY
IDLITDATA::_COPYITEM, IDLITDATA::_FREEITEM, IDLITDATA::_GETTYPEDESCRIPTION
IDLITDATA::_REGISTERPROPERTIES, IDLITDATA::_SETDATAOBSERVERS
IDLITGETITEMSIZE, IDLITLANGCATQUERY, _IDLitsys_GetSystem
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
METHODNAME:
IDLitData::RemoveDataObserver
PURPOSE:
The IDLitData::RemoveDataObserver procedure method removes the specified
observer object from this object's list of observers
CALLING SEQUENCE:
oData->[IDLitData::]RemoveDataObserver, oObserver
INPUTS:
oObserver - An IDL Component Data object that implements
the IIDLDataObserver interface
KEYWORD PARAMETERS:
NO_AUTODELETE - If set, remove the observer from the notifier list
without performing the autodelete.
CALLS: ***
IDLITDATA::ADDDATAOBSERVER, IDLITDATA::ADDMETADATA, IDLITDATA::CLEANUP
IDLITDATA::CLEARMETADATA, IDLITDATA::COPY, IDLITDATA::GETBYTYPE
IDLITDATA::GETDATA, IDLITDATA::GETDATAOBSERVERS, IDLITDATA::GETMETADATA
IDLITDATA::GETMETADATACOUNT, IDLITDATA::GETMETADATANAMES
IDLITDATA::GETPROPERTY, IDLITDATA::GETSIZE, IDLITDATA::GETTYPES
IDLITDATA::INIT, IDLITDATA::NOTIFYDATACHANGE, IDLITDATA::NOTIFYDATACOMPLETE
IDLITDATA::NOTIFYDATADELETE, IDLITDATA::REMOVEDATAOBSERVER
IDLITDATA::RESTORE, IDLITDATA::SETDATA, IDLITDATA::SETPROPERTY
IDLITDATA::_COPYITEM, IDLITDATA::_FREEITEM, IDLITDATA::_GETTYPEDESCRIPTION
IDLITDATA::_REGISTERPROPERTIES, IDLITDATA::_SETDATAOBSERVERS
IDLITGETITEMSIZE, IDLITLANGCATQUERY, _IDLitsys_GetSystem
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitDataContainer
PURPOSE:
This file implements the IDLitDataContainer class. This class provides
a data container that is aware of data objects stored in it. It uses
data identifiers to locate data objects stored in a data container
tree heirarchy.
CATEGORY:
IDL Tools
SUPERCLASSES:
_IDLitContainer
SUBCLASSES:
CREATION:
See IDLitDataContainer::Init
CALLS: ***
IDLITDATACONTAINER::ADD, IDLITDATACONTAINER::ADDBYIDENTIFIER
IDLITDATACONTAINER::CLEANUP, IDLITDATACONTAINER::COPY
IDLITDATACONTAINER::DISABLENOTIFY, IDLITDATACONTAINER::ENABLENOTIFY
IDLITDATACONTAINER::GETBYTYPE, IDLITDATACONTAINER::GETDATA
IDLITDATACONTAINER::GETIDENTIFIERS, IDLITDATACONTAINER::GETPROPERTY
IDLITDATACONTAINER::GETSIZE, IDLITDATACONTAINER::GETTYPES
IDLITDATACONTAINER::INIT, IDLITDATACONTAINER::ONDATACHANGE
IDLITDATACONTAINER::ONDATACOMPLETE, IDLITDATACONTAINER::ONDATADELETE
IDLITDATACONTAINER::REMOVE, IDLITDATACONTAINER::REMOVEBYIDENTIFIER
IDLITDATACONTAINER::SETAUTODELETEMODE, IDLITDATACONTAINER::SETDATA
IDLITDATACONTAINER::SETPROPERTY, IDLITDATACONTAINER::_GETID, UNIQ
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLArray2D
PURPOSE:
This file implements the IDLitData class. This class is used to store
vector (1d array) data
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitData
SUBCLASSES:
CREATION:
See IDLitDataIDLArray2D::Init
CALLS: ***
IDLITDATAIDLARRAY2D::INIT, IDLITDATAIDLARRAY2D::SETDATA, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLArray3D
PURPOSE:
This file implements the IDLitData class. This class is used to store
3d array data
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitData
SUBCLASSES:
CREATION:
See IDLitDataIDLArray3D::Init
CALLS: ***
IDLITDATAIDLARRAY3D::INIT, IDLITDATAIDLARRAY3D::SETDATA, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLImage
PURPOSE:
This file implements the IDLitDataIDLImage class.
This class is used to store image data and palette information
suitable for use with IDL image objects.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataContainer
SUBCLASSES:
CREATION:
See IDLitDataIDLImage::Init
CALLS: ***
IDLITDATAIDLIMAGE::ADD, IDLITDATAIDLIMAGE::CLEANUP
IDLITDATAIDLIMAGE::GETPROPERTY, IDLITDATAIDLIMAGE::INIT
IDLITDATAIDLIMAGE::ONDATACOMPLETE, IDLITDATAIDLIMAGE::SETPALETTE
IDLITDATAIDLIMAGE::SETPROPERTY, IDLITDATAIDLIMAGE::_PREPAREPALETTE
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLImagePixels
PURPOSE:
This file implements the IDLitDataIDLImagePixels class.
This class is used to store pixel data.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataContainer
SUBCLASSES:
CREATION:
See IDLitDataIDLImagePixels::Init
CALLS: ***
IDLITDATAIDLIMAGEPIXELS::GETDATA, IDLITDATAIDLIMAGEPIXELS::GETPROPERTY
IDLITDATAIDLIMAGEPIXELS::INIT, IDLITDATAIDLIMAGEPIXELS::SETDATA
IDLITDATAIDLIMAGEPIXELS::SETPROPERTY, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLPalette
PURPOSE:
This file implements the IDLitData class. This class is used to
store a palette
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitData
SUBCLASSES:
CREATION:
See IDLitDataIDLPalette::Init
METHODS:
This class has the following methods:
IDLitData::Init
CALLS: ***
IDLITDATAIDLPALETTE::INIT, IDLITDATAIDLPALETTE::SETDATA, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLPolyVertex
PURPOSE:
This file implements the IDLitDataIDLPolyVertex class. This class is used to store
vertex and connectivity lists that are suitable for use with IDL polyline and polygon
objects.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataContainer
SUBCLASSES:
CREATION:
See IDLitDataIDLPolyVertex::Init
CALLS: ***
IDLITDATAIDLPOLYVERTEX::INIT, IDLITDATAIDLPOLYVERTEX::SETDATA
IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataIDLVector
PURPOSE:
This file implements the IDLitData class. This class is used to store
vector (1d array) data
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitData
SUBCLASSES:
CREATION:
See IDLitDataIDLVector::Init
CALLS: ***
IDLITDATAIDLVECTOR::INIT, IDLITDATAIDLVECTOR::SETDATA, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitDataManagerFolder
PURPOSE:
This file implements the IDLitDataManagerFolder class. This class provides
This traversal is all built off of the identifier property provided by
the IDLitComponent object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitContainer
SUBCLASSES:
CREATION:
See IDLitDataManagerFolder::Init
METHODS:
This class has the following methods:
IDLitDataManagerFolder::Init
IDLitDataManagerFolder::Cleanup
INTERFACES:
IIDLProperty
IIDLContainer
CALLS: ***
IDLITDATAMANAGERFOLDER::ADD, IDLITDATAMANAGERFOLDER::ADDBYIDENTIFIER
IDLITDATAMANAGERFOLDER::ADDSUBFOLDER, IDLITDATAMANAGERFOLDER::CLEANUP
IDLITDATAMANAGERFOLDER::GETSIZE, IDLITDATAMANAGERFOLDER::INIT
IDLITDATAMANAGERFOLDER::ONDATACHANGE
IDLITDATAMANAGERFOLDER::ONDATACOMPLETE
IDLITDATAMANAGERFOLDER::ONDATADELETE, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitError
PURPOSE:
Generic error message object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitMessage
SUBCLASSES:
CREATION:
See IDLitError::Init
METHODS:
This class has the following methods:
IDLitError::Init
IDLitError::Cleanup
IDLitError::GetProperty
IDLitError::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITERROR::CLEANUP, IDLITERROR::GETPROPERTY, IDLITERROR::GETTEXTMESSAGE
IDLITERROR::INIT, IDLITERROR::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitFont
PURPOSE:
The IDLitFont class is the component wrapper for IDLgrFont.
CATEGORY:
Components
SUPERCLASSES:
IDLgrFont
SUBCLASSES:
METHODS:
Intrinisic Methods
IDLitFont::Cleanup
IDLitFont::Init
Private Methods
IIDLProperty Interface
IDLitFont::GetProperty
IDLitComponent::QueryPropertyDescriptor
IDLitComponent::RegisterProperty
IDLitFont::SetProperty
CALLS: ***
IDLITFONT::CLEANUP, IDLITFONT::GETFONT, IDLITFONT::GETPROPERTY
IDLITFONT::INIT, IDLITFONT::RESTORE, IDLITFONT::SETPROPERTY
IDLITFONT::_REGISTERPROPERTIES
MODIFICATION HISTORY:
Written by: Chris, August 2002
[Previous]
[Next]
METHODNAME:
IDLitFont::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitFont')
INPUTS:
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrFont
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITFONT::CLEANUP, IDLITFONT::GETFONT, IDLITFONT::GETPROPERTY
IDLITFONT::INIT, IDLITFONT::RESTORE, IDLITFONT::SETPROPERTY
IDLITFONT::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitFont::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitFont::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitFont::Init followed by the word "Get"
can be retrieved using IDLitFont::GetProperty.
CALLS: ***
IDLITFONT::CLEANUP, IDLITFONT::GETFONT, IDLITFONT::GETPROPERTY
IDLITFONT::INIT, IDLITFONT::RESTORE, IDLITFONT::SETPROPERTY
IDLITFONT::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitFont::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitFont::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitFont::Init followed by the word "Set"
can be set using IDLitFont::SetProperty.
CALLS: ***
IDLITFONT::CLEANUP, IDLITFONT::GETFONT, IDLITFONT::GETPROPERTY
IDLITFONT::INIT, IDLITFONT::RESTORE, IDLITFONT::SETPROPERTY
IDLITFONT::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitFont__Define
PURPOSE:
Defines the object structure for an IDLitFont object.
CALLS: ***
IDLITFONT::CLEANUP, IDLITFONT::GETFONT, IDLITFONT::GETPROPERTY
IDLITFONT::INIT, IDLITFONT::RESTORE, IDLITFONT::SETPROPERTY
IDLITFONT::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitgrAnnotateLayer
PURPOSE:
The IDLitgrAnnoateLayer class represents a layer (within a View) in
which annotations are drawn. This is a 2d layer for "on-glass" annotations.
CATEGORY:
Components
SUPERCLASSES:
IDLitGrLayer
CALLS: ***
IDLITGRANNOTATELAYER::ADD, IDLITGRANNOTATELAYER::GETWORLD
IDLITGRANNOTATELAYER::INIT, IDLITGRANNOTATELAYER::ONDATACOMPLETE
IDLITGRANNOTATELAYER::ONVIEWPORTCHANGE, IDLITGRANNOTATELAYER::RESTORE
IDLITGRANNOTATELAYER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitgrAnnotateLayer::Init
PURPOSE:
Initializes an IDLitgrLayer object.
KEYWORD PARAMETERS:
<Accepts all keywords accepted by the superclasses, plus the following:>
OUTPUTS:
This function method returns 1 on success, or 0 if initialization
fails.
CALLS: ***
IDLITGRANNOTATELAYER::ADD, IDLITGRANNOTATELAYER::GETWORLD
IDLITGRANNOTATELAYER::INIT, IDLITGRANNOTATELAYER::ONDATACOMPLETE
IDLITGRANNOTATELAYER::ONVIEWPORTCHANGE, IDLITGRANNOTATELAYER::RESTORE
IDLITGRANNOTATELAYER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitgrAnnotateLayer::GetWorld
PURPOSE:
Retrieves the World associated with this Layer.
CALLING SEQUENCE:
oWorld = oLayer->[IDLitgrAnnotateLayer::]GetWorld()
OUTPUTS:
This function method returns a reference to an IDLitgrWorld.
NOTES:
This overrides the implementation of IDLitGrLayer::GetWorld so
that the containment skipping within the annotation layer can be
taken into account.
CALLS: ***
IDLITGRANNOTATELAYER::ADD, IDLITGRANNOTATELAYER::GETWORLD
IDLITGRANNOTATELAYER::INIT, IDLITGRANNOTATELAYER::ONDATACOMPLETE
IDLITGRANNOTATELAYER::ONVIEWPORTCHANGE, IDLITGRANNOTATELAYER::RESTORE
IDLITGRANNOTATELAYER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitgrAnnotateLayer::OnDataComplete
PURPOSE:
The IDLitgrAnnotateLayer::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data flush.
CALLS: ***
IDLITGRANNOTATELAYER::ADD, IDLITGRANNOTATELAYER::GETWORLD
IDLITGRANNOTATELAYER::INIT, IDLITGRANNOTATELAYER::ONDATACOMPLETE
IDLITGRANNOTATELAYER::ONVIEWPORTCHANGE, IDLITGRANNOTATELAYER::RESTORE
IDLITGRANNOTATELAYER::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitgrAnnotateLayer__Define
PURPOSE:
Defines the object structure for an IDLitgrAnnotateLayer object.
CALLS: ***
IDLITGRANNOTATELAYER::ADD, IDLITGRANNOTATELAYER::GETWORLD
IDLITGRANNOTATELAYER::INIT, IDLITGRANNOTATELAYER::ONDATACOMPLETE
IDLITGRANNOTATELAYER::ONVIEWPORTCHANGE, IDLITGRANNOTATELAYER::RESTORE
IDLITGRANNOTATELAYER::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitgrBuffer
PURPOSE:
This class encapulsates the functionality of the
IDLitgrBuffer. This window, a sub-class of IDLgrBuffer is
primarly used to collapse the window and scene into
a single object.
CATEGORY:
Components
CALLS: ***
IDLITGRBUFFER::ADDWINDOWEVENTOBSERVER, IDLITGRBUFFER::CLEANUP
IDLITGRBUFFER::CLEARSELECTIONS, IDLITGRBUFFER::GETCURRENTVIEW
IDLITGRBUFFER::GETDIMENSIONS, IDLITGRBUFFER::GETEVENTMASK
IDLITGRBUFFER::GETPROPERTY, IDLITGRBUFFER::GETSCENE
IDLITGRBUFFER::GETSELECTEDITEMS, IDLITGRBUFFER::INIT
IDLITGRBUFFER::ONSCROLL, IDLITGRBUFFER::REMOVEWINDOWEVENTOBSERVER
IDLITGRBUFFER::SETCURRENTCURSOR, IDLITGRBUFFER::SETCURRENTZOOM
IDLITGRBUFFER::SETEVENTMASK, IDLITGRBUFFER::SETMANIPULATORMANAGER
IDLITGRBUFFER::SETPROPERTY, IDLITGRBUFFER::ZOOMIN, IDLITGRBUFFER::ZOOMOUT
IDLITGRBUFFER::_SETSCENE
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
METHODNAME:
IDLitgrBuffer::Cleanup
PURPOSE:
Performs all cleanup for the object.
CALLS: ***
IDLITGRBUFFER::ADDWINDOWEVENTOBSERVER, IDLITGRBUFFER::CLEANUP
IDLITGRBUFFER::CLEARSELECTIONS, IDLITGRBUFFER::GETCURRENTVIEW
IDLITGRBUFFER::GETDIMENSIONS, IDLITGRBUFFER::GETEVENTMASK
IDLITGRBUFFER::GETPROPERTY, IDLITGRBUFFER::GETSCENE
IDLITGRBUFFER::GETSELECTEDITEMS, IDLITGRBUFFER::INIT
IDLITGRBUFFER::ONSCROLL, IDLITGRBUFFER::REMOVEWINDOWEVENTOBSERVER
IDLITGRBUFFER::SETCURRENTCURSOR, IDLITGRBUFFER::SETCURRENTZOOM
IDLITGRBUFFER::SETEVENTMASK, IDLITGRBUFFER::SETMANIPULATORMANAGER
IDLITGRBUFFER::SETPROPERTY, IDLITGRBUFFER::ZOOMIN, IDLITGRBUFFER::ZOOMOUT
IDLITGRBUFFER::_SETSCENE
[Previous]
[Next]
CLASS_NAME:
IDLitgrClipboard
PURPOSE:
This class encapulsates the functionality of the
IDLitgrClipboard.
CATEGORY:
Components
CALLS: ***
IDLITGRCLIPBOARD::CLEANUP, IDLITGRCLIPBOARD::GETCURRENTVIEW
IDLITGRCLIPBOARD::GETDIMENSIONS, IDLITGRCLIPBOARD::GETPROPERTY
IDLITGRCLIPBOARD::GETSCENE, IDLITGRCLIPBOARD::GETSELECTEDITEMS
IDLITGRCLIPBOARD::INIT, IDLITGRCLIPBOARD::SETCURRENTCURSOR
IDLITGRCLIPBOARD::SETMANIPULATORMANAGER, IDLITGRCLIPBOARD::SETPROPERTY
IDLITGRCLIPBOARD::_SETSCENE
MODIFICATION HISTORY:
Written by: AGEH April 2005
[Previous]
[Next]
METHODNAME:
IDLitgrClipboard::Cleanup
PURPOSE:
Performs all cleanup for the object.
CALLS: ***
IDLITGRCLIPBOARD::CLEANUP, IDLITGRCLIPBOARD::GETCURRENTVIEW
IDLITGRCLIPBOARD::GETDIMENSIONS, IDLITGRCLIPBOARD::GETPROPERTY
IDLITGRCLIPBOARD::GETSCENE, IDLITGRCLIPBOARD::GETSELECTEDITEMS
IDLITGRCLIPBOARD::INIT, IDLITGRCLIPBOARD::SETCURRENTCURSOR
IDLITGRCLIPBOARD::SETMANIPULATORMANAGER, IDLITGRCLIPBOARD::SETPROPERTY
IDLITGRCLIPBOARD::_SETSCENE
[Previous]
[Next]
CLASS_NAME:
IDLitgrLayer
PURPOSE:
The IDLitgrLayer class represents a layer (within a View) in
which visualizations are drawn.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
MODIFICATION HISTORY:
Written by: DLD, Mar. 2001.
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::Init
PURPOSE:
Initializes an IDLitgrLayer object.
CALLING SEQUENCE:
oLayer = OBJ_NEW('IDLitgrLayer')
or
Result = oLayer->[IDLitgrLayer::]Init()
KEYWORD PARAMETERS:
<Accepts all keywords accepted by the superclasses, plus the following:>
STRETCH_TO_FIT (Get,Set): Set this keyword to indicate that the
visualization contents should be stretched to fill the viewport.
By default, the visualizations are scaled to fit the smallest
of the viewport dimensions, thereby maintaining aspect ratio.
OUTPUTS:
This function method returns 1 on success, or 0 if initialization
fails.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::Cleanup
PURPOSE:
Performs all cleanup for an IDLitgrLayer object.
CALLING SEQUENCE:
OBJ_DESTROY, oLayer
or
oLayer->[IDLitgrLayer::]Cleanup
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::GetProperty
PURPOSE:
The IDLitgrLayer::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]GetProperty
KEYWORD PARAMETERS:
Any keyword to IDLitgrLayer::Init followed by the word "Get"
can be retrieved using IDLitgrLayer::GetProperty.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::SetProperty
PURPOSE:
The IDLitgrLayer::SetProperty procedure method sets the
value of a property or group of properties.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]SetProperty
KEYWORD PARAMETERS:
<Accepts any keyword accepted by the superclass ::SetProperty method.>
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::_CorrectForAspectRatio
PURPOSE:
Computes appropriate viewplane rectangle to maintain aspect ratio
of the view volume XYZ range relative to the destination device's
dimensions.
Returns 1 if the frustum rectangle corrected for aspect ratio
has changed, or 0 if no change was required.
CALLING SEQUENCE:
bChange = oLayer->[IDLitgrLayer::]_CorrectForAspectRatio(virtualViewDims)
INPUTS:
virtualViewDims: A two-element vector, [width, height], specifying the
dimensions (in device units) of the (virtual, un-cropped) viewport
in which the aspect ratio of the visualization data is to be
maintained.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::_CorrectForZoom
PURPOSE:
Updates the virtual frustum rectangle to account for current zooming
factors.
Returns 1 if the frustum rectangle corrected for zoom
has changed, or 0 if no change was required.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]_CorrectForZoom, normClipRect
INPUTS:
normClipRect: A 4-element vector, [x,y,w,h], representing
the (un-canvas-zoomed) visible viewport rectangle (in
normalized coordinates relative to the virtual viewport)
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::ResetVirtualFrustumRect
PURPOSE:
Marks the virtual frustum rectangle as being dirty and requiring
recomputation.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]ResetVirtualFrustumRect
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::ComputeVirtualFrustumRect
PURPOSE:
Computes the virtual frustum rectangle from the original frustum
rectangle by correcting for aspect ratio and zooming according
to current factors.
Returns 1 if the frustum rectangle has changed, or 0 if no change
was required.
CALLING SEQUENCE:
bChange = oLayer->[IDLitgrLayer::]ComputeVirtualFrustumRect( $
virtualViewDims, normClipRect)
INPUTS:
virtualViewDims: A two-element vector, [width, height], specifying the
dimensions (in device units) of the (virtual, un-cropped) viewport
in which the aspect ratio of the visualization data is to be
maintained.
normClipRect: A 4-element vector, [x,y,w,h], representing
the (un-canvas-zoomed) visible viewport rectangle (in
normalized coordinates relative to the virtual viewport)
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::GetViewPlaneRect
PURPOSE:
The IDLitgrLayer::GetViewPlaneRect procedure method retrieves
the requested viewplane rectangle(s) associated with this layer.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]GetViewPlaneRect, $
ASPECT_RATIO_CORRECTED=namedVar, $
ORIGINAL=namedVar, $
ZOOM_CORRECTED=namedVar
KEYWORDS:
ASPECT_RATIO_CORRECTED: Set this keyword to a named variable that
upon return will contain the 4-element vector, [x,y,w,h],
representing the viewplane rectangle of this layer after it
has been corrected for aspect ratio.
ORIGINAL: Set this keyword to a named variable that
upon return will contain the 4-element vector, [x,y,w,h],
representing the original viewplane rectangle of this layer
(before aspect ratio or zoom corrections have been applied).
ZOOM_CORRECTED: Set this keyword to a named variable that
upon return will contain the 4-element vector, [x,y,w,h],
representing the viewplane rectangle of this layer after it
has been corrected for both aspect ratio and zooming.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::CropFrustum
PURPOSE:
The IDLitgrLayer::CropFrustum procedure method crops the
virtual viewplane rectangle of the frustum to the visible portion
of the scrolling destination.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]CropFrustum, oDestination
INPUTS:
oDestination: A reference to the (scrolling) destination object.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::GetWorld
PURPOSE:
Retrieves the World associated with this Layer.
CALLING SEQUENCE:
oWorld = oLayer->[IDLitgrLayer::]GetWorld()
OUTPUTS:
This function method returns a reference to an IDLitgrWorld.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::GetCurrentDataSpace
PURPOSE:
Retrieves the Dataspace associated with this Layer.
CALLING SEQUENCE:
oDS = oLayer->[IDLitgrLayer::]GetCurrentDataspace()
OUTPUTS:
This function method returns a reference to an Data Space or
a null object if one doesn't exist.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::SetCurrentDataSpace
PURPOSE:
Sets the given dataspace as the currently active dataspace associated
with this Layer.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]SetCurrentDataspace, DataSpace
INPUTS:
DataSpace: A reference to an IDLitVisIDataSpace that is to become
the current dataspace within this layer.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::OnViewZoom
PURPOSE:
The IDLitgrLayer::OnViewZoom procedure handles notification of a change
in the view zoom factor. The view frustum is updated accordingly.
CALLING SEQUENCE:
oObj->[IDLitgrLayer::]OnViewZoom, oView, oDestination
INPUTS:
oView: A reference to this layer's parent view.
oDestination: A reference to the destination within which the view
appears.
zoomFactor: The new zoom factor for the view.
normClipRect: A 4-element vector, [x,y,w,h], representing
the (un-canvas-zoomed) visible viewport rectangle (in
normalized coordinates relative to the virtual viewport)
KEYWORD PARAMETERS:
NO_NOTIFY: Set this keyword to a non-zero value to indicate that
contained visualizations should not be notified of the zoom factor
change. By default, contained visualizations are notfied.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::OnDataChange
PURPOSE:
The IDLitgrLayer::OnDataChange procedure method handles
notification of pending data changes within the contained
visualization hierarchy.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]OnDataChange, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitgrLayer::OnDataComplete
PURPOSE:
The IDLitgrLayer::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oLayer->[IDLitgrLayer::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data flush.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
METHODNAME:
IDLitGrLayer::Select
PURPOSE:
This procedure method handles notification that this object
has been selected.
If a parameter is not passed in, the mode is determined by
the keyword values.
If no keywords are set, a select operation is used.
CALLING SEQUENCE:
Obj->[IDLitGrLayer::]Select, Mode
INPUTS:
Mode - An integer representing the type of selection to perform.
Valid values include:
0 - Unselect
1 - Select
2 - Toggle (control key)
3 - Additive (shift key)
KEYWORD PARAMETERS:
ADDITIVE: Set this keyword to a nonzero value to indicate that
this layer should be selected as an addition to the
current selection list. Setting this keyword is equivalent to
setting the mode argument to 3.
NO_NOTIFY: Set this keyword to a nonzero value to indicate that
this layer's parent should not be notified of the selection.
By default, the parent is notified.
SELECT: Set this keyword to a nonzero value to indicate that
this layer should be selected (in isolation). Setting this
keyword is equivalent to setting the mode argument to 1.
TOGGLE: Set this keyword to a nonzero value to indicate that
the selection status of this layer should be toggled.
Setting this keyword is equivalent to setting the mode argument to 2.
UNSELECT: Set this keyword to a nonzero value to indicate that
this layer should be unselected. Setting this keyword is
equivalent to setting the mode argument to 0.
pro IDLitgrLayer::Select, iMode, $
ADDITIVE=ADDITIVE, $
NO_NOTIFY=NO_NOTIFY, $
SELECT=SELECT, $
TOGGLE=TOGGLE, $
UNSELECT=UNSELECT
; pragmas
compile_opt idl2, hidden
; Convert keywords to a mode parameter.
if (N_PARAMS() ne 1) then begin
case 1 of
KEYWORD_SET(UNSELECT) : iMode = 0
KEYWORD_SET(SELECT) : iMode = 1
KEYWORD_SET(ADDITIVE) : iMode = 3
KEYWORD_SET(TOGGLE) : iMode = 2
else : iMode = 1 ;; default SELECT
endcase
endif else if (iMode lt 0 or iMode gt 3) then $
return
; Check our toggle.
if (iMode eq 2) then $
iMode = (self.isSelected ? 0 : 3)
isSelected = iMode and 1 ; first bit set, we are going to select
wasSelected = self.isSelected
self.isSelected = isSelected
self->IDLgrView::GetProperty, _PARENT=oparent
; If notification is enabled, notify the parent.
if (not KEYWORD_SET(NO_NOTIFY))then begin
case iMode of
0: oParent->RemoveSelectedItem, self
1: oParent->SetSelectedItem, self
3: oParent->AddSelectedItem, self
endcase
endif
end
;---------------------------------------------------------------------------
+
METHODNAME:
IDLitGrLayer::IsSelected
PURPOSE:
This function method reports whether this layer is currently
selected.
CALLING SEQUENCE:
Result = Obj->[IDLitGrLayer::]IsSelected()
OUTPUTS:
This function returns a 1 if this layer is currently
selected, or 0 otherwise.
function IDLitGrLayer::IsSelected
compile_opt idl2, hidden
return, self.isSelected
end
---------------------------------------------------------------------------
Need to override our _IDLitContainer::Add method so we can send things
directly to our world. Otherwise, if a Light is added, it will end up
in our _IDLitContainer's container, which is the DataspaceRoot.
pro IDLitgrLayer::Add, oObjects, _REF_EXTRA=_extra
compile_opt idl2, hidden
oWorld = self->GetWorld()
oWorld->Add, oObjects, _EXTRA=_extra
end
---------------------------------------------------------------------------
Need to override our _IDLitContainer::Get method so we can retrieve
the Light container from the World. Otherwise, we won't be able to
find it, since we'll be looking in the DataspaceRoot.
function IDLitgrLayer::Get, ALL=all, $
COUNT=count, $
_REF_EXTRA=_EXTRA
compile_opt idl2, hidden
oObjs = self->_IDLitContainer::Get(ALL=all, $
COUNT=count, _EXTRA=_EXTRA)
if (~KEYWORD_SET(all)) then $
return, oObjs
oWorld = self->GetWorld()
oLights = oWorld->GetByIdentifier('LIGHTS')
if (OBJ_VALID(oLights)) then begin
oObjs = (count gt 0) ? [oObjs, oLights] : oLights
count++
endif
return, (count gt 0 ? oObjs : -1)
end
----------------------------------------------------------------------------
IDLitgrLayer::OnDimensionChange
Purpose:
This procedure method handles notification from the contained world
that the dimensionality has changed.
pro IDLitgrLayer::OnDimensionChange, oSubject, is3D
compile_opt idl2, hidden
if (is3D) then begin
self.margin2DX = 0.2
self.margin2DY = 0.2
endif else begin
self.margin2DX = 0.15
self.margin2DY = 0.15
endelse
end
----------------------------------------------------------------------------
Object Definition
----------------------------------------------------------------------------
----------------------------------------------------------------------------
+
IDLitgrLayer__Define
PURPOSE:
Defines the object structure for an IDLitgrLayer object.
CALLS: ***
IDLITGRLAYER::ADD, IDLITGRLAYER::ADDSELECTEDITEM, IDLITGRLAYER::CLEANUP
IDLITGRLAYER::COMPUTEVIRTUALFRUSTUMRECT, IDLITGRLAYER::CREATE
IDLITGRLAYER::CROPFRUSTUM, IDLITGRLAYER::GET
IDLITGRLAYER::GETCURRENTDATASPACE, IDLITGRLAYER::GETPROPERTY
IDLITGRLAYER::GETVIEWPLANERECT, IDLITGRLAYER::GETWORLD, IDLITGRLAYER::INIT
IDLITGRLAYER::ISSELECTED, IDLITGRLAYER::ONDATACHANGE
IDLITGRLAYER::ONDATACOMPLETE, IDLITGRLAYER::ONDIMENSIONCHANGE
IDLITGRLAYER::ONVIEWPORTCHANGE, IDLITGRLAYER::ONVIEWZOOM
IDLITGRLAYER::RESETVIRTUALFRUSTUMRECT, IDLITGRLAYER::RESTORE
IDLITGRLAYER::RESTOREMARGINS, IDLITGRLAYER::SELECT
IDLITGRLAYER::SETCURRENTDATASPACE, IDLITGRLAYER::SETPROPERTY
IDLITGRLAYER::SETSELECTEDITEM, IDLITGRLAYER::SHUTDOWN
IDLITGRLAYER::_CORRECTFORASPECTRATIO, IDLITGRLAYER::_CORRECTFORZOOM
IDLITGRLAYER::_REGISTERPROPERTIES, IDLITGRLAYER::_ROUNDMARGIN
IDLITGRLAYER::_UPDATEMARGINS, IDLITLAYER::SETPRIMARYSELECTEDITEM
[Previous]
[Next]
CLASS_NAME:
IDLitgrScene
PURPOSE:
The IDLitgrScene class represents the entire scene to be drawn
within a destination object (such as an IDLitWindow or IDLitBuffer).
CATEGORY:
Components
SUPERCLASSES:
IDLgrScene
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
MODIFICATION HISTORY:
Written by: DLD, Mar. 2001.
[Previous]
[Next]
METHODNAME:
IDLitgrScene::Init
PURPOSE:
Initializes an IDLitgrScene object.
CALLING SEQUENCE:
oScene = OBJ_NEW('IDLitgrScene', oDestination)
or
Result = oScene->[IDLitgrScene::]Init(oDestination)
INPUTS:
oDestination: A reference to a destination object (window
or buffer) in which this scene will be drawn.
OUTPUTS:
This function method returns 1 on success, or 0 if initialization
fails.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::Cleanup
PURPOSE:
Performs all cleanup for an IDLitgrScene object.
CALLING SEQUENCE:
OBJ_DESTROY, oScene
or
oScene->[IDLitgrScene::]Cleanup
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::GetProperty
PURPOSE:
The IDLitgrScene::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]GetProperty
KEYWORD PARAMETERS:
Any keyword to IDLitgrScene::Init followed by the word "Get"
can be retrieved using IDLitgrScene::GetProperty. In addition
the following keywords are available:
DESTINATION Set this keyword to a named variable that upon return
will contain a reference to the destination object in which the
scene is drawn.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::GetCurrentView
PURPOSE:
Retrieves the current View within the scene.
CALLING SEQUENCE:
oView = oScene->[IDLitgrScene::]GetCurrentView()
OUTPUTS:
This function method returns a reference to an IDLitgrView.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::SetCurrentView
PURPOSE:
Sets the current View within the scene.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]SetCurrentView, oView
INPUTS:
oView: A reference to an IDLitgrView that is to
become the current View within the scene.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::OnResize
PURPOSE:
Handles notification of a resize of the destination.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]OnResize, oNotifier, width, height
INPUTS:
oNotifier: A reference to the destination object that has been resized.
width: The new width of the destination.
height: The new height of the destination.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::OnZoom
PURPOSE:
Handles notification of a zoom of the destination.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]OnResize, oNotifier, width, height
INPUTS:
oNotifier: A reference to the destination object that has been zoomed.
width: The new width of the destination.
height: The new height of the destination.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::OnScroll
PURPOSE:
The IDLitgrScene::OnScroll procedure method crops the
contained Views to the visible portion of a scrolling
destination.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]OnScroll, oNotifier, ScrollX, ScrollY
INPUTS:
oNotifier: A reference to the object sending notification
of the scroll.
ScrollX, ScrollY: The coordinates (in device units, relative
to the virtual canvas) of the lower-left corner of the
visible area of the scrolled destination.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::OnDataChange
PURPOSE:
The IDLitgrScene::OnDataChange procedure method handles
notification of pending data changes within the contained
visualization hierarchy.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]OnDataChange, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitgrScene::OnDataComplete
PURPOSE:
The IDLitgrScene::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oScene->[IDLitgrScene::]OnDataComplete, oNotifier
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
IDLitgrScene__Define
PURPOSE:
Defines the object structure for an IDLitgrScene object.
CALLS: ***
IDLITGRSCENE::ADD, IDLITGRSCENE::CLEARSELECTIONS, IDLITGRSCENE::DRAW
IDLITGRSCENE::GETCURRENTVIEW, IDLITGRSCENE::GETPROPERTY
IDLITGRSCENE::GETSELECTEDITEMS, IDLITGRSCENE::INIT
IDLITGRSCENE::ONDATACHANGE, IDLITGRSCENE::ONDATACOMPLETE
IDLITGRSCENE::ONRESIZE, IDLITGRSCENE::ONSCROLL, IDLITGRSCENE::ONZOOM
IDLITGRSCENE::REMOVE, IDLITGRSCENE::SETCURRENTVIEW
IDLITGRSCENE::SETPROPERTY
[Previous]
[Next]
PURPOSE:
The IDLitgrView class represents a rectangular area (within a scene)
in which one or more layers of visualizations are to be drawn.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
MODIFICATION HISTORY:
Written by: DLD, June 2001.
[Previous]
[Next]
METHODNAME:
IDLitgrView::Init
PURPOSE:
Initializes an IDLitgrView object.
CALLING SEQUENCE:
oView = OBJ_NEW('IDLitgrView')
or
Result = oView->[IDLitgrView::]Init()
KEYWORD PARAMETERS:
<Accepts all keywords accepted by the superclasses.>
OUTPUTS:
This function method returns 1 on success, or 0 if initialization
fails.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::Cleanup
PURPOSE:
Performs all cleanup for an IDLitgrView object.
CALLING SEQUENCE:
OBJ_DESTROY, oView
or
oView->[IDLitgrView::]Cleanup
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::GetProperty
PURPOSE:
The IDLitgrView::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
oView->[IDLitgrView::]GetProperty
KEYWORD PARAMETERS:
Any keyword to IDLitgrView::Init followed by the word "Get"
can be retrieved using IDLitgrView::GetProperty.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::SetProperty
PURPOSE:
The IDLitgrView::SetProperty procedure method sets the
value of a property or group of properties.
CALLING SEQUENCE:
oView->[IDLitgrView::]SetProperty
KEYWORD PARAMETERS:
Any keyword to IDLitgrView::Init followed by the word "Set"
can be set using IDLitgrView::SetProperty.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::OnResize
PURPOSE:
Handles notification of a resize of the destination.
CALLING SEQUENCE:
oView->[IDLitgrView::]OnResize, oNotifier, width, height
INPUTS:
oNotifier: A reference to the destination object that has been resized.
width: The new width of the destination.
height: The new height of the destination.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::OnCanvasZoom
PURPOSE:
Handles notification of a zoom of the destination.
CALLING SEQUENCE:
oView->[IDLitgrView::]OnCanvasZoom, oNotifier, width, height
INPUTS:
oNotifier: A reference to the destination object that has been zoomed.
width: The new width of the destination.
height: The new height of the destination.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::OnCanvasScroll
PURPOSE:
The IDLitgrView::OnCanvasScroll procedure method crops the View
to the visible portion of the scrolling canvas.
CALLING SEQUENCE:
oView->[IDLitgrView::]OnCanvasScroll, oNotifier, ScrollX, ScrollY
INPUTS:
oNotifier: A reference to the object sending notification
of the scroll.
ScrollX, ScrollY: The coordinates (in device units, relative
to the virtual canvas) of the lower-left corner of the
visible area of the scrolled destination
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::Scroll
PURPOSE:
The IDLitgrView::Scroll procedure method scrolls the view
by the given amount relative to the default center.
CALLING SEQUENCE:
oView->[IDLitgrView::]Scroll, hScroll, vScroll
INPUTS:
hScroll: A scalar representing the horizontal scroll to be
applied (measured in device pixel units). This factor can
be positive (scroll right) or negative (scroll left).
vScroll: A scalar representing the vertical scroll to be
applied (measured in device pixel units). This factor can
be positive (scroll up) or negative (scroll down).
KEYWORDS:
NO_UPDATE: Set this keyword to a non-zero value to indicate
that the window should not be redrawn following the scroll.
By default, the window is redrawn.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::ZoomToFit
PURPOSE:
The IDLitgrView::ZoomToFit procedure method zooms and/or scrolls
the view to fit the given items within its visible portion.
CALLING SEQUENCE:
oView->[IDLitgrView::]ZoomToFit, oTargets
INPUTS:
oTargets: A vector of references to the visualizations that
are to be fit within the visible portion of the view.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::CropViewport
PURPOSE:
The IDLitgrView::CropViewport procedure method crops the viewport
to the visible portion of the scrolling destination.
CALLING SEQUENCE:
oView->[IDLitgrView::]CropViewport, oDestination
INPUTS:
oDestination: A reference to the (scrolling) destination object.
KEYWORDS:
NO_NOTIFY: Set this keyword to a non-zero value to indicate that
the contained layers should not be notified of the crop. By default,
the contained layers are notified.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::SetCurrentZoom
PURPOSE:
The IDLitgrView::SetCurrentZoom procedure modifies the dimensions of
the XY portion of the view frustum of each of its view layers.
CALLING SEQUENCE:
oView->[IDLitgrView::]SetCurrentZoom, ZoomFactor[, CENTER=[x,y]]
INPUTS:
ZoomFactor: A positive floating point value representing the new
zoom factor. A value less than 1.0 will cause the contents of the
view to visually appear smaller; a value greater than 1.0 will
cause the contents to appear larger.
KEYWORD PARAMETERS:
CENTER: Set this keyword to a two-element vector, [x,y], indicating
the location (in un-canvas-zoomed device units relative to the
virtual viewport prior to the new zoom) about which the zoom is to
be centered. The default is the center of the visible viewport.
NO_NOTIFY: Set this keyword to a non-zero value to indicate that
notification to registered objects should not occur.
NO_UPDATES: Set this keyword to a non-zero value to indicate that
the parent scene should not be notified.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::GetCurrentLayer
PURPOSE:
Retrieves the current layer within the View.
CALLING SEQUENCE:
oViewLayer = oView->[IDLitgrView::]GetCurrentLayer()
OUTPUTS:
This function method returns a reference to an IDLitgrLayer.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::SetCurrentLayer
PURPOSE:
Sets the current Layer within the View.
CALLING SEQUENCE:
oView->[IDLitgrView::]SetCurrentLayer, oViewLayer
INPUTS:
oViewLayer: A reference to an IDLitgrLayer that is to
become the current ViewLayer within the View.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::SetViewport
PURPOSE:
Sets the visible viewport for the View (relative to the virtual
canvas).
CALLING SEQUENCE:
oView->[IDLitgrView::]SetViewport, Location, Dimensions
INPUTS:
Location: A two-element vector, [x,y], specifying the location
of the lower lefthand corner of the viewport (relative to
the lower lefthand corner of the window).
Dimensions: A two-element vector, [width, height], specifying the
dimensions of the viewport.
KEYWORD PARAMETERS:
FORCE_UPDATE: Set this keyword to a non-zero value to indicate that
viewport updates should be forced. By default, updates only
occur if the viewport has actually changed from previous values.
RESET_SCREEN_SIZES: Set this keyword to a non-zero value to indicate
that the screen sizes associated with visualizations (used to
honor zoomOnResize=0) should be reset. By default, the screen
sizes remain untouched.
UNITS: Set this keyword to a scalar indicating the units in
which the viewport location and dimensions are specified.
Valid values include:
0 = Device (the default)
1 = Inches
2 = Centimeters
3 = Normalized
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::GetViewport
PURPOSE:
Retrieves the viewport for the View.
CALLING SEQUENCE:
Result = oView->[IDLitgrView::]GetViewport(oDestination)
INPUTS:
oDestination: A reference to an IDLitWindow or IDLitBuffer whose
device resolution is to be taken into account when computing
viewport dimensions.
KEYWORD PARAMETERS:
LOCATION: Set this keyword to a named variable that upon
return will contain a two-element vector, [x,y], representing
the location of the lower-left corner of the viewport.
UNITS: Set this keyword to a scalar indicating the units in
which the viewport dimensions and location should be returned.
Valid values include:
0 = Device (the default)
1 = Inches
2 = Centimeters
3 = Normalized
VIRTUAL: Set this keyword to indicate that the returned
viewport should represent the full visible viewport (with location
and dimensions relative to the overall virtual canvas of the
destination device). By default, the returned viewport represents
the cropped visible viewport (with location and dimensions relative
to the visible portion of the scrolled destination).
This keyword is mutually exclusive of NORMALIZED_VISIBLE.
NORMALIZED_VISIBLE: Set this keyword to indicate that the returned
viewport should represent the full visible portion of the viewport
(with location and dimension in normalized units relative to the
virtual viewport). By default, the returned viewport represents the
cropped visible portion (with location and dimensions relative to the
visible portion of the scrolled destination). If this keyword is
set, the UNITS keyword is ignored (normalized units are assumed).
This keyword is mutually exclusive of VIRTUAL.
OUTPUTS:
This function method returns a two-element vector, [width,height],
representing the dimensions of the viewport.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::OnDataChange
PURPOSE:
The IDLitgrView::OnDataChange procedure method handles
notification of pending data changes within the contained
visualization hierarchy.
CALLING SEQUENCE:
oView->[IDLitgrView::]OnDataChange, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrView::OnDataComplete
PURPOSE:
The IDLitgrView::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oView->[IDLitgrView::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitGrView::Select
PURPOSE:
This procedure method handles notification that this object
has been selected.
If a parameter is not passed in, the mode is determined by
the keyword values.
If no keywords are set, a select operation is used.
CALLING SEQUENCE:
Obj->[IDLitGrView::]Select, Mode
INPUTS:
Mode - An integer representing the type of selection to perform.
Valid values include:
0 - Unselect
1 - Select
2 - Toggle (control key)
KEYWORD PARAMETERS:
ADDITIVE: If set, this will just cause a select. You cannot have
muliplte views selected at a time
NO_NOTIFY: Set this keyword to a nonzero value to indicate that
this views's parent should not be notified of the selection.
By default, the parent is notified.
SELECT: Set this keyword to a nonzero value to indicate that
this view should be selected (in isolation). Setting this
keyword is equivalent to setting the mode argument to 1.
TOGGLE: Set this keyword to a nonzero value to indicate that
the selection status of this view should be toggled.
Setting this keyword is equivalent to setting the mode argument to 2.
UNSELECT: Set this keyword to a nonzero value to indicate that
this view should be unselected. Setting this keyword is
equivalent to setting the mode argument to 0.
pro IDLitgrView::Select, iMode, $
ADDITIVE=ADDITIVE, $
NO_NOTIFY=NO_NOTIFY, $
SELECT=SELECT, $
SKIP_MACRO=skipMacro, $
TOGGLE=TOGGLE, $
UNSELECT=UNSELECT
; pragmas
compile_opt idl2, hidden
; Convert keywords to a mode parameter.
if (N_PARAMS() ne 1) then begin
case 1 of
KEYWORD_SET(UNSELECT) : iMode = 0
KEYWORD_SET(SELECT) : iMode = 1
KEYWORD_SET(ADDITIVE) : iMode = 1
KEYWORD_SET(TOGGLE) : iMode = 2
else : iMode = 1 ;; default SELECT
endcase
endif else if (iMode lt 0 or iMode gt 3) then $
return
; Check our toggle.
if (iMode eq 2) then $
iMode = (self.isSelected ? 0 : 3)
isSelected = iMode and 1 ; first bit set, we are going to select
wasSelected = self.isSelected
self.isSelected = isSelected
; If notification is enabled, notify the parent.
if (not KEYWORD_SET(NO_NOTIFY))then begin
case iMode of
0: self->RemoveSelectedItem, self
1: self->SetSelectedItem, self
endcase
if ~keyword_set(skipMacro) then begin
oTool = self->GetTool()
if (OBJ_VALID(oTool)) then begin
oSrvMacro = oTool->GetService('MACROS')
if OBJ_VALID(oSrvMacro) then begin
case iMode of
0: macroMode = 2
1: macroMode = 0
endcase
; SELECTION_TYPE=1, position in container
oSrvMacro->AddSelectionChange, self, $
MODE=macroMode, $
SELECTION_TYPE=1
endif
endif
endif
endif
;; Now make sure we are the current view
if(self.isSelected ne 0)then begin
self->getproperty, parent=oScene
oScene->SetcurrentView, self
endif
end
;---------------------------------------------------------------------------
+
METHODNAME:
IDLitGrView::IsSelected
PURPOSE:
This function method reports whether this view is currently
selected.
CALLING SEQUENCE:
Result = Obj->[IDLitGrView::]IsSelected()
OUTPUTS:
This function returns a 1 if this view is currently
selected, or 0 otherwise.
function IDLitGrView::IsSelected
compile_opt idl2, hidden
return, self.isSelected
end
----------------------------------------------------------------------------
Object Definition
----------------------------------------------------------------------------
----------------------------------------------------------------------------
+
IDLitgrView__Define
PURPOSE:
Defines the object structure for an IDLitgrView object.
CALLS: ***
IDLITGRVIEW::ADD, IDLITGRVIEW::ADDSELECTEDITEM, IDLITGRVIEW::CLEANUP
IDLITGRVIEW::CROPVIEWPORT, IDLITGRVIEW::DISABLEPIXELSCALE
IDLITGRVIEW::ENABLEPIXELSCALE, IDLITGRVIEW::ENFORCEPIXELSCALE
IDLITGRVIEW::GETCURRENTLAYER, IDLITGRVIEW::GETPIXELDATASIZE
IDLITGRVIEW::GETPIXELSCALETARGETS, IDLITGRVIEW::GETPROPERTY
IDLITGRVIEW::GETVIEWPORT, IDLITGRVIEW::GETVIRTUALVIEWPORT, IDLITGRVIEW::INIT
IDLITGRVIEW::ISSELECTED, IDLITGRVIEW::ONCANVASSCROLL
IDLITGRVIEW::ONCANVASZOOM, IDLITGRVIEW::ONDATACHANGE
IDLITGRVIEW::ONDATACOMPLETE, IDLITGRVIEW::ONRESIZE
IDLITGRVIEW::REMOVESELECTEDITEM, IDLITGRVIEW::RESTORE
IDLITGRVIEW::RESTOREMARGINS, IDLITGRVIEW::SCROLL, IDLITGRVIEW::SELECT
IDLITGRVIEW::SETCURRENTLAYER, IDLITGRVIEW::SETCURRENTZOOM
IDLITGRVIEW::SETPROPERTY, IDLITGRVIEW::SETSELECTEDITEM
IDLITGRVIEW::SETSELECTVISUAL, IDLITGRVIEW::SETVIEWPORT
IDLITGRVIEW::ZOOMTOFIT, IDLITGRVIEW::_INSERTHIGHLIGHT
IDLITGRVIEW::_REGISTERPROPERTIES, IDLITGRVIEW::_UPDATEOUTLINE
IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitgrWinScene
PURPOSE:
This class encapulsates the functionality of the
IDLitgrWinScene. This window, a sub-class of IDLitWindow is
primarly used to collapse the window and scene into
a single object.
CATEGORY:
Components
CALLS: ***
IDLITGRWINSCENE::CLEANUP, IDLITGRWINSCENE::GETPROPERTY
IDLITGRWINSCENE::INIT, IDLITGRWINSCENE::RESTORE
IDLITGRWINSCENE::SETPROPERTY, IDLITGRWINSCENE::_REGISTERPROPERTIES
IDLITGRWINSCENE::_SETSCENE
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
METHODNAME:
IDLitgrWinScene::Cleanup
PURPOSE:
Performs all cleanup for the object.
CALLS: ***
IDLITGRWINSCENE::CLEANUP, IDLITGRWINSCENE::GETPROPERTY
IDLITGRWINSCENE::INIT, IDLITGRWINSCENE::RESTORE
IDLITGRWINSCENE::SETPROPERTY, IDLITGRWINSCENE::_REGISTERPROPERTIES
IDLITGRWINSCENE::_SETSCENE
[Previous]
[Next]
CLASS_NAME:
IDLitgrWorld
PURPOSE:
The IDLitgrWorld class represents the overall collection of
visualizations to be drawn within a ViewLayer.
CATEGORY:
Components
SUPERCLASSES:
IDLgrModel
IDLitSelectParent
IDLitIMessaging
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::Init
PURPOSE:
Initializes an IDLitgrWorld object.
CALLING SEQUENCE:
oWorld = OBJ_NEW('IDLitgrWorld')
or
Result = oWorld->[IDLitgrWorld::]Init()
KEYWORD PARAMETERS:
<Accepts all keywords accepted by the superclasses.>
OUTPUTS:
This function method returns 1 on success, or 0 if initialization
fails.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::Cleanup
PURPOSE:
Performs all cleanup for an IDLitgrWorld object.
CALLING SEQUENCE:
OBJ_DESTROY, oWorld
or
oWorld->[IDLitgrWorld::]Cleanup
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::Add
PURPOSE:
Adds the given object(s) to the World's graphics hierarchy.
CALLING SEQUENCE:
oWorld->Add, oObjects
INPUTS:
oObjects: A reference (or vector of references) to the object(s)
to be added to the World's graphics hierarchy.
_IDLitVisualizations are added to the DataSpace; other objects
are simply added to the World.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::Remove
PURPOSE:
Removes the given object(s) from the World's graphics
hierarchy.
CALLING SEQUENCE:
oWorld->Remove[, oObjects | /ALL]
INPUTS:
oObject: A reference (or vector of references) to the
_IDLitVisualization(s) to be removed from the World's graphics
hierarchy.
_IDLitVisualizations are removed from the DataSpace; other objects
are simply removed from the World.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::InitDataSpaces
PURPOSE:
Initializes the dataspaces for this world.
CALLING SEQUENCE:
Result = oWorld->[IDLitgrWorld::]InitDataSpaces()
OUTPUTS:
This function method returns a 1 on success, or 0 otherwise.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::_GetDataSpaceRoot
PURPOSE:
Undocumented method to retrieve the DataspaceRoot from within the World.
Required for IDLitgrLayer::Init.
CALLING SEQUENCE:
oDataSpaceRoot = oWorld->[IDLitgrWorld::]_GetDataSpaceRoot()
OUTPUTS:
This function method returns a reference to an object
that inherits from IDLitVisDataSpaceRoot.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::GetCurrentDataSpace
PURPOSE:
Retrieves the currently active DataSpace from within the World.
CALLING SEQUENCE:
oDataSpace = oWorld->[IDLitgrWorld::]GetCurrentDataSpace()
OUTPUTS:
This function method returns a reference to an object
that inherits from IDLitVisIDataSpace.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::SetCurrentDataSpace
PURPOSE:
Sets the given dataspace as the currently active dataspace associated
with this world.
CALLING SEQUENCE:
oWorld->[IDLitgrWorld::]SetCurrentDataspace, DataSpace
INPUTS:
DataSpace: A reference to an IDLitVisIDataSpace that is to become
the current dataspace within this layer.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::GetDataSpaces
PURPOSE:
This function method retrieves the list of dataspaces contained by the
dataspace root within this world.
CALLING SEQUENCE:
Result = oWorld->[IDLitgrWorld::]GetDataspaces()
OUTPUTS:
This function returns a vector of references to IDLitVisIDataSpace
objects contained by the dataspace root within this world.
KEYWORDS:
COUNT: Set this keyword to a named variable that upon return will
contain the number of dataspaces returned.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::OnDataChange
PURPOSE:
The IDLitgrWorld::OnDataChange procedure method handles
notification of pending data changes within the contained
visualization hierarchy.
CALLING SEQUENCE:
oWorld->[IDLitgrWorld::]OnDataChange, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitgrWorld::OnDataComplete
PURPOSE:
The IDLitgrWorld::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oWorld->[IDLitgrWorld::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data flush.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitGrWorld::OnDimensionChange
PURPOSE:
This procedure method handles notification that the dimensionality
of a contained object has changed.
CALLING SEQUENCE:
Obj->[IDLitGrWorld::]OnDimensionChange, Subject, is3D
INPUTS:
Subject: A reference to the object sending notification
of the dimensionality change.
is3D: new 3D setting of Subject.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitGrWorld::OnAxesRequestChange
PURPOSE:
This procedure method handles notification that the axes request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesRequestChange implementation
so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitgrWorld:]OnAxesRequestChange, Subject, axesRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes request change.
axesRequest: new axes request setting of Subject.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitGrWorld::OnAxesStyleRequestChange
PURPOSE:
This procedure method handles notification that the axes style request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesStyleRequestChange
implementation so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitGrWorld:]OnAxesStyleRequestChange, Subject, styleRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes style request change.
styleRequest: new style request setting of Subject.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLiGrWorld::GetProperty
PURPOSE:
This procedure method retrieves the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitGrWorld::]GetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::GetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitGrWorld::Init followed by the word "Get" can be retrieved
using IDLitGrWorld::GetProperty.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
METHODNAME:
IDLitGrWorld::SetProperty
PURPOSE:
This procedure method sets the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitGrWorld::]SetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::SetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitGrWorld::Init followed by the word "Set" can be retrieved
using IDLitGrWorld::SetProperty.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
IDLitgrWorld__Define
Purpose:
Defines the object structure for an IDLitgrWorld object.
CALLS: ***
IDLITGRWORLD::ADD, IDLITGRWORLD::CLEANUP, IDLITGRWORLD::GETCURRENTDATASPACE
IDLITGRWORLD::GETDATASPACES, IDLITGRWORLD::GETPROPERTY, IDLITGRWORLD::INIT
IDLITGRWORLD::INITDATASPACES, IDLITGRWORLD::ONAXESREQUESTCHANGE
IDLITGRWORLD::ONAXESSTYLEREQUESTCHANGE, IDLITGRWORLD::ONDATACHANGE
IDLITGRWORLD::ONDATACOMPLETE, IDLITGRWORLD::ONDIMENSIONCHANGE
IDLITGRWORLD::REMOVE, IDLITGRWORLD::SETCURRENTDATASPACE
IDLITGRWORLD::SETPROPERTY, IDLITGRWORLD::UPDATELIGHTS
IDLITGRWORLD::_CREATELIGHTMODEL, IDLITGRWORLD::_GETDATASPACEROOT
IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitIMessaging
PURPOSE:
This file implements the set of methods that provide a consistent
programming interface to the iTools developer. The methods
defined by this class are always available as methods on the
exposed framework classes.
It is intended that other framework objects will sub-class from
this and thus provide this simple messaging interface to the
framework user. This class should not be created directly.
CATEGORY:
IDL Tools
SUPERCLASSES:
None.
CALLS: ***
IDLITIMESSAGING::ADDONNOTIFYOBSERVER, IDLITIMESSAGING::DOONNOTIFY
IDLITIMESSAGING::ERRORMESSAGE, IDLITIMESSAGING::GETTOOL
IDLITIMESSAGING::INIT, IDLITIMESSAGING::ONNOTIFY
IDLITIMESSAGING::PROBESTATUSMESSAGE, IDLITIMESSAGING::PROGRESSBAR
IDLITIMESSAGING::PROMPTUSERTEXT, IDLITIMESSAGING::PROMPTUSERYESNO
IDLITIMESSAGING::REMOVEONNOTIFYOBSERVER, IDLITIMESSAGING::SIGNALERROR
IDLITIMESSAGING::STATUSMESSAGE, IDLITIMESSAGING::_SETTOOL, IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitLayout
PURPOSE:
The IDLitLayout class represents the view layout of a scene.
CATEGORY:
Components
SUPERCLASSES:
SUBCLASSES:
METHODS:
CALLS: ***
IDLITLAYOUT::GETPROPERTY, IDLITLAYOUT::GETVIEWPORT, IDLITLAYOUT::INIT
IDLITLAYOUT::SETPROPERTY
MODIFICATION HISTORY:
Written by: CT, Jan 2003
[Previous]
[Next]
IDLitLayout__Define
PURPOSE:
Defines the object structure for an IDLitLayout object.
CALLS: ***
IDLITLAYOUT::GETPROPERTY, IDLITLAYOUT::GETVIEWPORT, IDLITLAYOUT::INIT
IDLITLAYOUT::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitLayoutFreeform
PURPOSE:
The IDLitLayoutFreeform class represents the view layout of a scene.
CATEGORY:
Components
SUPERCLASSES:
SUBCLASSES:
METHODS:
CALLS: ***
IDLITLAYOUTFREEFORM::INIT
MODIFICATION HISTORY:
Written by: CT, May 2002
[Previous]
[Next]
IDLitLayoutFreeform__Define
PURPOSE:
Defines the object structure for an IDLitLayoutFreeform object.
CALLS: ***
IDLITLAYOUTFREEFORM::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitLayoutGrid
PURPOSE:
The IDLitLayoutGrid class represents the view layout of a scene.
CATEGORY:
Components
SUPERCLASSES:
SUBCLASSES:
METHODS:
CALLS: ***
IDLITLAYOUTGRID::GETVIEWPORT, IDLITLAYOUTGRID::INIT
MODIFICATION HISTORY:
Written by: CT, May 2002
[Previous]
[Next]
IDLitLayoutGrid__Define
PURPOSE:
Defines the object structure for an IDLitLayoutGrid object.
CALLS: ***
IDLITLAYOUTGRID::GETVIEWPORT, IDLITLAYOUTGRID::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitLayoutInset
PURPOSE:
The IDLitLayoutInset class represents the view layout of a scene.
CALLS: ***
IDLITLAYOUTINSET::GETPROPERTY, IDLITLAYOUTINSET::GETVIEWPORT
IDLITLAYOUTINSET::INIT
MODIFICATION HISTORY:
Written by: CT, Jan 2002
[Previous]
[Next]
IDLitLayoutInset__Define
PURPOSE:
Defines the object structure for an IDLitLayoutInset object.
CALLS: ***
IDLITLAYOUTINSET::GETPROPERTY, IDLITLAYOUTINSET::GETVIEWPORT
IDLITLAYOUTINSET::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitLayoutTrio
PURPOSE:
The IDLitLayoutTrio class represents the view layout of a scene.
CALLS: ***
IDLITLAYOUTTRIO::GETPROPERTY, IDLITLAYOUTTRIO::GETVIEWPORT
IDLITLAYOUTTRIO::INIT
MODIFICATION HISTORY:
Written by: CT, Jan 2002
[Previous]
[Next]
IDLitLayoutTrio__Define
PURPOSE:
Defines the object structure for an IDLitLayoutTrio object.
CALLS: ***
IDLITLAYOUTTRIO::GETPROPERTY, IDLITLAYOUTTRIO::GETVIEWPORT
IDLITLAYOUTTRIO::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitMacroFolder
PURPOSE:
This file implements the IDLitMacroFolder class.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitContainer
SUBCLASSES:
CREATION:
See IDLitMacroFolder::Init
METHODS:
This class has the following methods:
IDLitMacroFolder::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITMACROFOLDER::GETPROPERTY, IDLITMACROFOLDER::INIT
IDLITMACROFOLDER::RESTORE, IDLITMACROFOLDER::SETPROPERTY
IDLITMACROFOLDER::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitManipAnnotation
PURPOSE:
Abstract class for the manipulator system of the IDL component framework.
Indentend to manage the goemetry of an annoation
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipAnnotation::Init
CALLS: ***
IDLITMANIPANNOTATION::CANCELANNOTATION
IDLITMANIPANNOTATION::COMMITANNOTATION, IDLITMANIPANNOTATION::INIT
[Previous]
[Next]
METHODNAME:
IDLitManipAnnotation::Init
PURPOSE:
The IDLitManipAnnotation::Init function method initializes the
annotation manipulator.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipAnnotation')
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITMANIPANNOTATION::CANCELANNOTATION
IDLITMANIPANNOTATION::COMMITANNOTATION, IDLITMANIPANNOTATION::INIT
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipCropBox
PURPOSE:
The IDLitManipCropBox class represents a manipulator used to select
the bounding box of a region to be cropped from a target.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPCROPBOX::CLEANUP
IDLITMANIPCROPBOX::COMMITUNDOVALUES, IDLITMANIPCROPBOX::DOACTION
IDLITMANIPCROPBOX::GETCURSORTYPE, IDLITMANIPCROPBOX::GETPROPERTY
IDLITMANIPCROPBOX::GETSTATUSMESSAGE, IDLITMANIPCROPBOX::INIT
IDLITMANIPCROPBOX::ONKEYBOARD, IDLITMANIPCROPBOX::ONLOSECURRENTMANIPULATOR
IDLITMANIPCROPBOX::ONMOUSEDOWN, IDLITMANIPCROPBOX::ONMOUSEMOTION
IDLITMANIPCROPBOX::ONMOUSEUP, IDLITMANIPCROPBOX::ONNOTIFY
IDLITMANIPCROPBOX::QUERYAVAILABILITY, IDLITMANIPCROPBOX::RECORDUNDOVALUES
IDLITMANIPCROPBOX::SETPROPERTY, IDLITMANIPCROPBOX::UPDATETOMATCHOPERATION
IDLITMANIPCROPBOX::_DOCROP, IDLITMANIPCROPBOX::_DOHITTEST
IDLITMANIPCROPBOX::_DOREGISTERCURSOR
IDLITMANIPCROPBOX::_FINDMANIPULATORTARGETS
IDLITMANIPCROPBOX::_PREPARECROPBOXVISUAL
IDLITMANIPCROPBOX::_PREPAREGREYOUT
IDLITMANIPCROPBOX::_PREPARERESIZEHANDLES
IDLITMANIPCROPBOX::_RESIZECROPBOX, IDLITMANIPCROPBOX::_SETCROPBOX
IDLITMANIPCROPBOX::_SETTARGET, IDLITMANIPCROPBOX::_TRANSLATECROPBOX
IDLITMANIPCROPBOX::_UPDATEGREYOUT
[Previous]
[Next]
CLASS_NAME:
IDLitManipImagePlane
PURPOSE:
The Volume Image Plane manipulator. This class provides the user with
a way to select the image plane by its selection visual and move it.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipImagePlane::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipImagePlane::Init
IDLitManipImagePlane::Cleanup
INTERFACES:
IIDLProperty
IIDLWindowEvent
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPIMAGEPLANE::INIT
IDLITMANIPIMAGEPLANE::ONMOUSEDOWN, IDLITMANIPIMAGEPLANE::ONMOUSEMOTION
IDLITMANIPIMAGEPLANE::ONMOUSEUP
[Previous]
[Next]
METHODNAME:
IDLitManipImagePlane::Init
PURPOSE:
The IDLitManipImagePlane::Init function method initializes the
Image Plane Manipulator component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipImagePlane', <manipulator type>)
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPIMAGEPLANE::INIT
IDLITMANIPIMAGEPLANE::ONMOUSEDOWN, IDLITMANIPIMAGEPLANE::ONMOUSEMOTION
IDLITMANIPIMAGEPLANE::ONMOUSEUP
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipLine
PURPOSE:
The line manipulator.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipLine::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipLine::Init
IDLitManipLine::Cleanup
IDLitManipLine::
INTERFACES:
IIDLProperty
IIDLWindowEvent
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPLINE::GETCURSORTYPE
IDLITMANIPLINE::GETSTATUSMESSAGE, IDLITMANIPLINE::INIT
IDLITMANIPLINE::ONMOUSEDOWN, IDLITMANIPLINE::ONMOUSEMOTION
IDLITMANIPLINE::ONMOUSEUP, IDLITMANIPLINE::SETCURRENTMANIPULATOR
[Previous]
[Next]
METHODNAME:
IDLitManipLine::Init
PURPOSE:
The IDLitManipLine::Init function method initializes the
Line Manipulator component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipLine', <manipulator type>)
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPLINE::GETCURSORTYPE
IDLITMANIPLINE::GETSTATUSMESSAGE, IDLITMANIPLINE::INIT
IDLITMANIPLINE::ONMOUSEDOWN, IDLITMANIPLINE::ONMOUSEMOTION
IDLITMANIPLINE::ONMOUSEUP, IDLITMANIPLINE::SETCURRENTMANIPULATOR
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipLineProfile
PURPOSE:
Line manipulator that allows the user to draw a line in the window
and then use the resulting line to generate a line profile by
creating a plot tool with the line used as the plot data.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipLineProfile::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPLINEPROFILE::DOACTION
IDLITMANIPLINEPROFILE::INIT, IDLITMANIPLINEPROFILE::ONMOUSEDOWN
IDLITMANIPLINEPROFILE::ONMOUSEMOTION, IDLITMANIPLINEPROFILE::ONMOUSEUP
IDLITMANIPLINEPROFILE::_DOREGISTERCURSOR
IDLITMANIPLINEPROFILE::_FINDMANIPULATORTARGETS
[Previous]
[Next]
METHODNAME:
IDLitManipLineProfile::Init
PURPOSE:
The IDLitManipLineProfile::Init function method initializes the
Manipulator container component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipLineProfile', <manipulator type>)
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPLINEPROFILE::DOACTION
IDLITMANIPLINEPROFILE::INIT, IDLITMANIPLINEPROFILE::ONMOUSEDOWN
IDLITMANIPLINEPROFILE::ONMOUSEMOTION, IDLITMANIPLINEPROFILE::ONMOUSEUP
IDLITMANIPLINEPROFILE::_DOREGISTERCURSOR
IDLITMANIPLINEPROFILE::_FINDMANIPULATORTARGETS
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipRange
PURPOSE:
The IDLitManipRange class represents a manipulator used to modify
the XYZ range of one or more target dataspace objects.
CALLS: ***
IDLITMANIPRANGE::INIT, IDLITMANIPRANGE::_FINDMANIPULATORTARGETS
[Previous]
[Next]
METHODNAME:
IDLitManipRange::Init
PURPOSE:
The IDLitManipRange::Init function method initializes the
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oManipulator = OBJ_NEW('IDLitManipRange')
CALLS: ***
IDLITMANIPRANGE::INIT, IDLITMANIPRANGE::_FINDMANIPULATORTARGETS
[Previous]
[Next]
CLASS_NAME:
IDLitManipRangeBox
PURPOSE:
The IDLitManipRangeBox class represents a manipulator used to modify
the XYZ range of one or more target dataspace objects. The dataspace
range modification occurs by clicking and dragging a bounding box.
CALLS: ***
IDLITMANIPRANGEBOX::CLEANUP, IDLITMANIPRANGEBOX::INIT
IDLITMANIPRANGEBOX::ONMOUSEDOWN, IDLITMANIPRANGEBOX::ONMOUSEMOTION
IDLITMANIPRANGEBOX::ONMOUSEUP, IDLITMANIPRANGEBOX::_DISABLEAUTOUPDATES
IDLITMANIPRANGEBOX::_DOREGISTERCURSOR
IDLITMANIPRANGEBOX::_FINDMANIPULATORTARGETS
[Previous]
[Next]
METHODNAME:
IDLitManipRangeBox::Init
PURPOSE:
The IDLitManipRangeBox::Init function method initializes the
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oManipulator = OBJ_NEW('IDLitManipRangeBox')
CALLS: ***
IDLITMANIPRANGEBOX::CLEANUP, IDLITMANIPRANGEBOX::INIT
IDLITMANIPRANGEBOX::ONMOUSEDOWN, IDLITMANIPRANGEBOX::ONMOUSEMOTION
IDLITMANIPRANGEBOX::ONMOUSEUP, IDLITMANIPRANGEBOX::_DISABLEAUTOUPDATES
IDLITMANIPRANGEBOX::_DOREGISTERCURSOR
IDLITMANIPRANGEBOX::_FINDMANIPULATORTARGETS
[Previous]
[Next]
IDLitManipRangeBox::_DisableAutoUpdates
Purpose:
This procedure method disables auto-updates of the XYZ Ranges
for each target dataspace.
CALLS: ***
IDLITMANIPRANGEBOX::CLEANUP, IDLITMANIPRANGEBOX::INIT
IDLITMANIPRANGEBOX::ONMOUSEDOWN, IDLITMANIPRANGEBOX::ONMOUSEMOTION
IDLITMANIPRANGEBOX::ONMOUSEUP, IDLITMANIPRANGEBOX::_DISABLEAUTOUPDATES
IDLITMANIPRANGEBOX::_DOREGISTERCURSOR
IDLITMANIPRANGEBOX::_FINDMANIPULATORTARGETS
[Previous]
[Next]
CLASS_NAME:
IDLitManipRangePan
PURPOSE:
The IDLitManipRangeBox class represents a manipulator used to modify
the XYZ range of one or more target dataspace objects. The dataspace
range modification occurs by clicking a visual that indicates either
a pan left or a pan right.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEPAN::GETCURSORTYPE
IDLITMANIPRANGEPAN::GETSTATUSMESSAGE, IDLITMANIPRANGEPAN::INIT
IDLITMANIPRANGEPAN::ONMOUSEDOWN, IDLITMANIPRANGEPAN::ONMOUSEUP
IDLITMANIPRANGEPAN::_DISABLEAUTOUPDATES
IDLITMANIPRANGEPAN::_DOREGISTERCURSOR
IDLITMANIPRANGEPAN::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEPAN::_PAN
[Previous]
[Next]
METHODNAME:
IDLitManipRangePan::Init
PURPOSE:
The IDLitManipRangePan::Init function method initializes the
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oManipulator = OBJ_NEW('IDLitManipRangePan')
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEPAN::GETCURSORTYPE
IDLITMANIPRANGEPAN::GETSTATUSMESSAGE, IDLITMANIPRANGEPAN::INIT
IDLITMANIPRANGEPAN::ONMOUSEDOWN, IDLITMANIPRANGEPAN::ONMOUSEUP
IDLITMANIPRANGEPAN::_DISABLEAUTOUPDATES
IDLITMANIPRANGEPAN::_DOREGISTERCURSOR
IDLITMANIPRANGEPAN::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEPAN::_PAN
[Previous]
[Next]
IDLitManipRangePan::_DisableAutoUpdates
Purpose:
This procedure method disables auto-updates of the XYZ Ranges
for each target dataspace.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEPAN::GETCURSORTYPE
IDLITMANIPRANGEPAN::GETSTATUSMESSAGE, IDLITMANIPRANGEPAN::INIT
IDLITMANIPRANGEPAN::ONMOUSEDOWN, IDLITMANIPRANGEPAN::ONMOUSEUP
IDLITMANIPRANGEPAN::_DISABLEAUTOUPDATES
IDLITMANIPRANGEPAN::_DOREGISTERCURSOR
IDLITMANIPRANGEPAN::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEPAN::_PAN
[Previous]
[Next]
CLASS_NAME:
IDLitManipRangeZoom
PURPOSE:
The IDLitManipRangeBox class represents a manipulator used to modify
the XYZ range of one or more target dataspace objects. The dataspace
range modification occurs by clicking a visual that indicates either
a zoom in or a zoom out.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEZOOM::GETCURSORTYPE
IDLITMANIPRANGEZOOM::GETSTATUSMESSAGE, IDLITMANIPRANGEZOOM::INIT
IDLITMANIPRANGEZOOM::ONMOUSEDOWN, IDLITMANIPRANGEZOOM::ONMOUSEUP
IDLITMANIPRANGEZOOM::_DISABLEAUTOUPDATES
IDLITMANIPRANGEZOOM::_DOREGISTERCURSOR
IDLITMANIPRANGEZOOM::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEZOOM::_ZOOM
[Previous]
[Next]
METHODNAME:
IDLitManipRangeZoom::Init
PURPOSE:
The IDLitManipRangeZoom::Init function method initializes the
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oManipulator = OBJ_NEW('IDLitManipRangeZoom')
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEZOOM::GETCURSORTYPE
IDLITMANIPRANGEZOOM::GETSTATUSMESSAGE, IDLITMANIPRANGEZOOM::INIT
IDLITMANIPRANGEZOOM::ONMOUSEDOWN, IDLITMANIPRANGEZOOM::ONMOUSEUP
IDLITMANIPRANGEZOOM::_DISABLEAUTOUPDATES
IDLITMANIPRANGEZOOM::_DOREGISTERCURSOR
IDLITMANIPRANGEZOOM::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEZOOM::_ZOOM
[Previous]
[Next]
IDLitManipRangeZoom::_DisableAutoUpdates
Purpose:
This procedure method disables auto-updates of the XYZ Ranges
for each target dataspace.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPRANGEZOOM::GETCURSORTYPE
IDLITMANIPRANGEZOOM::GETSTATUSMESSAGE, IDLITMANIPRANGEZOOM::INIT
IDLITMANIPRANGEZOOM::ONMOUSEDOWN, IDLITMANIPRANGEZOOM::ONMOUSEUP
IDLITMANIPRANGEZOOM::_DISABLEAUTOUPDATES
IDLITMANIPRANGEZOOM::_DOREGISTERCURSOR
IDLITMANIPRANGEZOOM::_FINDMANIPULATORTARGETS, IDLITMANIPRANGEZOOM::_ZOOM
[Previous]
[Next]
CLASS_NAME:
IDLitManipROI
PURPOSE:
This class represents a manipulator for creating regions of interest.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROI::Init
PURPOSE:
The IDLitManipROI::Init function method initializes the
manipulator object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipROI')
or
Obj->[IDLitManipROI::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses. In addition, the following keywords
are supported:
NO_SNAP_TO_GRID: Set this keyword to a non-zero value to indicate
that ROI vertices should not be snapped to the grid (if any) associated
with the target visualization. By default, the ROI vertices are
snapped to the grid.
SHIFT_CONSTRAINT: Set this keyword to enable <Shift> key constraints
when creating the ROI.
TARGET_CLASSNAMES: Set this keyword to a string (or vector of
strings) representing the classname(s) of visualization objects
that can have an ROI. The default is 'IDLitVisImage'.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROI::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitManipROI::]Cleanup
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::OnMouseMotion
PURPOSE:
This procedure method handles a mouse motion event for this manipulator.
INPUTS:
oWin: A reference to the IDLitWindow object in which the
mouse event occurred.
x: X coordinate of the mouse event.
y: Y coordinate of the mouse event.
KeyMods: An integer representing the keyboard modifiers
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::InitTargetClassnames
PURPOSE:
This procedure method prepares the list of classnames of visualization
objects that can have ROIs.
CALLING SEQUENCE:
Obj->[IDLitManpROI::]InitTargetClassnames
KEYWORD PARAMETERS:
TARGET_CLASSNAMES: Set this keyword to a string (or vector of
strings) representing the classname(s) of visualization objects
that can have an ROI. The default is 'IDLitVisImage'.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::IdentifyTargetVisualization
PURPOSE:
This procedure method determines which visualization should
be treated as the target for ROI create.
CALLING SEQUENCE:
Obj->[IDLitManpROI::]IdentifyTargetVisualization, oWin
INPUTS:
oWin: A reference to the window object in which the
ROI manipulation is occurring.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::WindowToVis
PURPOSE:
This procedure method converts the given window selection coordinate
to the corresponding target visualization coordinate.
CALLING SEQUENCE:
Obj->[IDLitManipROI::]WindowToVis, oWin, winX, winY, visX, visY, visZ
INPUTS:
oWin: A reference to the window object.
winX, winY: The [x,y] window location in device coordinates.
visX, visY, visZ: Named variables that upon return will contain
the [x,y,z] target visualization coordinate corresponding to the
given window coordinate.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::SubmitTargetVertex
PURPOSE:
This procedure method submits the given vertex (in the dataspace
of the target visualization) to the current ROI.
CALLING SEQUENCE:
Obj->[IDLitManipROI::]SubmitTargetVertex, visX, visY, visZ
INPUTS:
visX, visY, visZ: The [x,y,z] location (in the dataspace of
the current target visualization) to be submitted to the
current ROI.
KEYWORD PARAMETERS:
GRID_LOCATION: A 2-element vector, [ix,iy], representing
the grid location that corresponds to the given visX,visY,visZ
values. (Note: if the target visualization is not snapping to
a grid, this vector will be [0,0].)
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI::ValidateROI
PURPOSE:
This function method determines whether the current ROI is
valid.
CALLING SEQUENCE:
Result = Obj->[IDLitManipROI::]ValidateROI()
OUTPUTS:
This function returns a 1 if the current ROI is valid (i.e.,
may be committed), or a 0 if the ROI is invalid.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROI:_DoRegisterCursor
PURPOSE:
This procedure method registers the cursor to be associated with
this manipulator.
CALLING SEQUENCE:
Obj->[IDLitManipROI::]_DoRegisterCursor, strName
INPUTS:
strName: A string representing the name to be associated
with the cursor.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIDefine
[Previous]
[Next]
NAME:
IDLitManipROI::Define
PURPOSE:
Defines the object structure for an IDLitManipROI object.
CALLS: ***
IDENTITY, IDLITLANGCATQUERY, IDLITMANIPROI::CLEANUP
IDLITMANIPROI::IDENTIFYTARGETVISUALIZATION, IDLITMANIPROI::INIT
IDLITMANIPROI::INITTARGETCLASSNAMES, IDLITMANIPROI::ONMOUSEDOWN
IDLITMANIPROI::ONMOUSEMOTION, IDLITMANIPROI::ONMOUSEUP
IDLITMANIPROI::QUERYAVAILABILITY, IDLITMANIPROI::SUBMITTARGETVERTEX
IDLITMANIPROI::VALIDATEROI, IDLITMANIPROI::WINDOWTOVIS
IDLITMANIPROI::_DOREGISTERCURSOR, idlitmaniproi__define [10]
idlitmaniproi__define [1], idlitmaniproi__define [2]
idlitmaniproi__define [3], idlitmaniproi__define [4]
idlitmaniproi__define [5], idlitmaniproi__define [6]
idlitmaniproi__define [7], idlitmaniproi__define [8]
idlitmaniproi__define [9]
[Previous]
[Next]
CLASS_NAME:
IDLitManipROIFree
PURPOSE:
This class represents a manipulator for freehand regions of interest.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROIFree::Init
PURPOSE:
The IDLitManipROIFree::Init function method initializes the
manipulator object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipROIFree')
or
Obj->[IDLitManipROIFree::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIFree::OnMouseDown
PURPOSE:
This procedure method handles a mouse down event for this manipulator.
INPUTS:
oWin: A reference to the IDLitWindow object in which the
mouse event occurred.
x: X coordinate of the mouse event.
y: Y coordinate of the mouse event.
iButton: An integer representing a mask for which button pressed
KeyMods: An integer representing the keyboard modifiers
nClicks: The number of times the mouse was clicked.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIFree::SubmitTargetVertex
PURPOSE:
This procedure method submits the given vertex (in the dataspace
of the target visualization) to the current ROI.
CALLING SEQUENCE:
Obj->[IDLitManipROIFree::]SubmitTargetVertex, visX, visY, visZ
INPUTS:
visX, visY, visZ: The [x,y,z] location (in the dataspace of
the current target visualization) to be submitted to the
current ROI.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIFree::ValidateROI
PURPOSE:
This function method determines whether the current ROI is
valid.
CALLING SEQUENCE:
Result = Obj->[IDLitManipROIFree::]ValidateROI()
OUTPUTS:
This function returns a 1 if the current ROI is valid (i.e.,
may be committed), or a 0 if the ROI is invalid.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIFree::_DoRegisterCursor
PURPOSE:
This procedure method registers the cursor to be associated with
this manipulator.
CALLING SEQUENCE:
Obj->[IDLitManipROIFree::]_DoRegisterCursor, strName
INPUTS:
strName: A string representing the name to be associated
with the cursor.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR
CALLED BY:
IDLitManipROIFreeDefine
[Previous]
[Next]
NAME:
IDLitManipROIFree::Define
PURPOSE:
Defines the object structure for an IDLitManipROIFree object.
CALLS: ***
IDLITMANIPROIFREE::INIT, IDLITMANIPROIFREE::ONMOUSEDOWN
IDLITMANIPROIFREE::SUBMITTARGETVERTEX, IDLITMANIPROIFREE::VALIDATEROI
IDLITMANIPROIFREE::_DOREGISTERCURSOR, idlitmaniproifree__define [1]
idlitmaniproifree__define [2], idlitmaniproifree__define [3]
idlitmaniproifree__define [4], idlitmaniproifree__define [5]
idlitmaniproifree__define [6]
[Previous]
[Next]
CLASS_NAME:
IDLitManipROIOval
PURPOSE:
This class represents a manipulator for oval regions of interest.
CALLS: ***
IDLITMANIPROIOVAL::INIT, IDLITMANIPROIOVAL::ONMOUSEDOWN
IDLITMANIPROIOVAL::SUBMITTARGETVERTEX, IDLITMANIPROIOVAL::VALIDATEROI
CALLED BY:
IDLitManipROIOvalDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROIOval::Init
PURPOSE:
The IDLitManipROIOval::Init function method initializes the
manipulator object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipROIOval')
or
Obj->[IDLitManipROIOval::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITMANIPROIOVAL::INIT, IDLITMANIPROIOVAL::ONMOUSEDOWN
IDLITMANIPROIOVAL::SUBMITTARGETVERTEX, IDLITMANIPROIOVAL::VALIDATEROI
CALLED BY:
IDLitManipROIOvalDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIOval::SubmitTargetVertex
PURPOSE:
This procedure method submits the given vertex (in the dataspace
of the target visualization) to the current ROI.
CALLING SEQUENCE:
Obj->[IDLitManipROIOval::]SubmitTargetVertex, visX, visY, visZ
INPUTS:
visX, visY, visZ: The [x,y,z] location (in the dataspace of
the current target visualization) to be submitted to the
current ROI.
KEYWORD PARAMETERS:
GRID_LOCATION: A 2-element vector, [ix,iy], representing
the grid location that corresponds to the given visX,visY,visZ
values. (Note: if the target visualization is not snapping to
a grid, this vector will be [0,0].)
CALLS: ***
IDLITMANIPROIOVAL::INIT, IDLITMANIPROIOVAL::ONMOUSEDOWN
IDLITMANIPROIOVAL::SUBMITTARGETVERTEX, IDLITMANIPROIOVAL::VALIDATEROI
CALLED BY:
IDLitManipROIOvalDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIOval::ValidateROI
PURPOSE:
This function method determines whether the current ROI is
valid.
CALLING SEQUENCE:
Result = Obj->[IDLitManipROIOval::]ValidateROI()
OUTPUTS:
This function returns a 1 if the current ROI is valid (i.e.,
may be committed), or a 0 if the ROI is invalid.
CALLS: ***
IDLITMANIPROIOVAL::INIT, IDLITMANIPROIOVAL::ONMOUSEDOWN
IDLITMANIPROIOVAL::SUBMITTARGETVERTEX, IDLITMANIPROIOVAL::VALIDATEROI
CALLED BY:
IDLitManipROIOvalDefine
[Previous]
[Next]
NAME:
IDLitManipROIOval::Define
PURPOSE:
Defines the object structure for an IDLitManipROIOval object.
CALLS: ***
IDLITMANIPROIOVAL::INIT, IDLITMANIPROIOVAL::ONMOUSEDOWN
IDLITMANIPROIOVAL::SUBMITTARGETVERTEX, IDLITMANIPROIOVAL::VALIDATEROI
idlitmaniproioval__define [1], idlitmaniproioval__define [2]
idlitmaniproioval__define [3], idlitmaniproioval__define [4]
[Previous]
[Next]
CLASS_NAME:
IDLitManipROIPoly
PURPOSE:
This class represents a manipulator for polygonal regions of interest.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROIPoly::Init
PURPOSE:
The IDLitManipROIPoly::Init function method initializes the
manipulator object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipROIPoly')
or
Obj->[IDLitManipROIPoly::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROIPoly::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitManipROIPoly::]Cleanup
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIPoly::OnMouseUp
PURPOSE:
Implements the OnMouseUp method. This method is often used to
complete an interactive operation.
PARAMETERS:
oWin: Source of the event
x: X coordinate
y: Y coordinate
iButton: Mask for which button released
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIPoly::OnMouseMotion
PURPOSE:
This procedure method handles a mouse motion event for this manipulator.
INPUTS:
oWin: A reference to the IDLitWindow object in which the
mouse event occurred.
x: X coordinate of the mouse event.
y: Y coordinate of the mouse event.
KeyMods: An integer representing the keyboard modifiers
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIPoly::_GetSegmentVerts
PURPOSE:
This procedure method computes the vertices along the segment
from the stored XYZ point to the given point.
CALLING SEQUENCE:
Obj->[IDLitManipROIPoly::]_GetSegmentVerts, x1, y1, z1, $
segX, segY, segZ
INPUTS:
x1, y1, z1: The [x,y,z] location (in the dataspace of
the current target visualization) of the final vertex of
the segment.
segX, segY, segZ: Named variables that upon return will
contain the the X, Y, and Z components of the vertices
along the segment.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIPoly::SubmitTargetVertex
PURPOSE:
This procedure method submits the given vertex (in the dataspace
of the target visualization) to the current ROI.
CALLING SEQUENCE:
Obj->[IDLitManipROIPoly::]SubmitTargetVertex, visX, visY, visZ
INPUTS:
visX, visY, visZ: The [x,y,z] location (in the dataspace of
the current target visualization) to be submitted to the
current ROI.
KEYWORD PARAMETERS:
GRID_LOCATION: A 2-element vector, [ix,iy], representing
the grid location that corresponds to the given visX,visY,visZ
values. (Note: if the target visualization is not snapping to
a grid, this vector will be [0,0].)
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIPoly::ValidateROI
PURPOSE:
This function method determines whether the current ROI is
valid.
CALLING SEQUENCE:
Result = Obj->[IDLitManipROIPoly::]ValidateROI()
OUTPUTS:
This function returns a 1 if the current ROI is valid (i.e.,
may be committed), or a 0 if the ROI is invalid.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS
CALLED BY:
IDLitManipROIPolyDefine
[Previous]
[Next]
NAME:
IDLitManipROIPoly::Define
PURPOSE:
Defines the object structure for an IDLitManipROIPoly object.
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPROIPOLY::CLEANUP, IDLITMANIPROIPOLY::INIT
IDLITMANIPROIPOLY::ONKEYBOARD, IDLITMANIPROIPOLY::ONMOUSEDOWN
IDLITMANIPROIPOLY::ONMOUSEMOTION, IDLITMANIPROIPOLY::ONMOUSEUP
IDLITMANIPROIPOLY::SUBMITTARGETVERTEX, IDLITMANIPROIPOLY::VALIDATEROI
IDLITMANIPROIPOLY::_GETSEGMENTVERTS, idlitmaniproipoly__define [1]
idlitmaniproipoly__define [2], idlitmaniproipoly__define [3]
idlitmaniproipoly__define [4], idlitmaniproipoly__define [5]
idlitmaniproipoly__define [6], idlitmaniproipoly__define [7]
idlitmaniproipoly__define [8]
[Previous]
[Next]
CLASS_NAME:
IDLitManipROIRect
PURPOSE:
This class represents a manipulator for rectangular regions of interest.
CALLS: ***
IDLITMANIPROIRECT::INIT, IDLITMANIPROIRECT::ONMOUSEDOWN
IDLITMANIPROIRECT::SUBMITTARGETVERTEX, IDLITMANIPROIRECT::VALIDATEROI
CALLED BY:
IDLitManipROIRectDefine
[Previous]
[Next]
METHODNAME:
IDLitManipROIRect::Init
PURPOSE:
The IDLitManipROIRect::Init function method initializes the
manipulator object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipROIRect')
or
Obj->[IDLitManipROIRect::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITMANIPROIRECT::INIT, IDLITMANIPROIRECT::ONMOUSEDOWN
IDLITMANIPROIRECT::SUBMITTARGETVERTEX, IDLITMANIPROIRECT::VALIDATEROI
CALLED BY:
IDLitManipROIRectDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIRect::SubmitTargetVertex
PURPOSE:
This procedure method submits the given vertex (in the dataspace
of the target visualization) to the current ROI.
CALLING SEQUENCE:
Obj->[IDLitManipROIRect::]SubmitTargetVertex, visX, visY, visZ
INPUTS:
visX, visY, visZ: The [x,y,z] location (in the dataspace of
the current target visualization) to be submitted to the
current ROI.
CALLS: ***
IDLITMANIPROIRECT::INIT, IDLITMANIPROIRECT::ONMOUSEDOWN
IDLITMANIPROIRECT::SUBMITTARGETVERTEX, IDLITMANIPROIRECT::VALIDATEROI
CALLED BY:
IDLitManipROIRectDefine
[Previous]
[Next]
METHOD_NAME:
IDLitManipROIRect::ValidateROI
PURPOSE:
This function method determines whether the current ROI is
valid.
CALLING SEQUENCE:
Result = Obj->[IDLitManipROIRect::]ValidateROI()
OUTPUTS:
This function returns a 1 if the current ROI is valid (i.e.,
may be committed), or a 0 if the ROI is invalid.
CALLS: ***
IDLITMANIPROIRECT::INIT, IDLITMANIPROIRECT::ONMOUSEDOWN
IDLITMANIPROIRECT::SUBMITTARGETVERTEX, IDLITMANIPROIRECT::VALIDATEROI
CALLED BY:
IDLitManipROIRectDefine
[Previous]
[Next]
NAME:
IDLitManipROIRect::Define
PURPOSE:
Defines the object structure for an IDLitManipROIRect object.
CALLS: ***
IDLITMANIPROIRECT::INIT, IDLITMANIPROIRECT::ONMOUSEDOWN
IDLITMANIPROIRECT::SUBMITTARGETVERTEX, IDLITMANIPROIRECT::VALIDATEROI
idlitmaniproirect__define [1], idlitmaniproirect__define [2]
idlitmaniproirect__define [3], idlitmaniproirect__define [4]
[Previous]
[Next]
CLASS_NAME:
IDLitManipScale
PURPOSE:
The scale manipulator.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipScale::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipScale::Init
IDLitManipScale::Cleanup
IDLitManipScale::
INTERFACES:
IIDLProperty
IIDLWindowEvent
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPSCALE::GETCURSORTYPE
IDLITMANIPSCALE::GETSTATUSMESSAGE, IDLITMANIPSCALE::INIT
IDLITMANIPSCALE::ONMOUSEDOWN, IDLITMANIPSCALE::ONMOUSEMOTION
IDLITMANIPSCALE::ONMOUSEUP, IDLITMANIPSCALE::SETCURRENTMANIPULATOR
IDLITMANIPSCALE::_CAPTUREMACROHISTORY, IDLITMANIPSCALE::_DOREGISTERCURSOR
IDLITMANIPSCALE::_SCALE, IDLITMANIPSCALE::_SCALECENTER
[Previous]
[Next]
METHODNAME:
IDLitManipScale::Init
PURPOSE:
The IDLitManipScale::Init function method initializes the
ScaleManipulator component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipScale', <manipulator type>)
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPSCALE::GETCURSORTYPE
IDLITMANIPSCALE::GETSTATUSMESSAGE, IDLITMANIPSCALE::INIT
IDLITMANIPSCALE::ONMOUSEDOWN, IDLITMANIPSCALE::ONMOUSEMOTION
IDLITMANIPSCALE::ONMOUSEUP, IDLITMANIPSCALE::SETCURRENTMANIPULATOR
IDLITMANIPSCALE::_CAPTUREMACROHISTORY, IDLITMANIPSCALE::_DOREGISTERCURSOR
IDLITMANIPSCALE::_SCALE, IDLITMANIPSCALE::_SCALECENTER
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipSurfContour
PURPOSE:
This class implements a manipulator that will interactively add a
contour line to a surface. When the mouse is down, the user can
interactively adjust the level of the drawn contour line.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipAnnotation
SUBCLASSES:
CREATION:
See IDLitManipSurfContour::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipSurfContour::Init
IDLitManipSurfContour::...
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPSURFCONTOUR::DOACTION
IDLITMANIPSURFCONTOUR::INIT, IDLITMANIPSURFCONTOUR::ONMOUSEDOWN
IDLITMANIPSURFCONTOUR::ONMOUSEMOTION, IDLITMANIPSURFCONTOUR::ONMOUSEUP
IDLITMANIPSURFCONTOUR::_CALCULATEANDSETLEVELVALUE
IDLITMANIPSURFCONTOUR::_FINDMANIPULATORTARGETS
[Previous]
[Next]
METHODNAME:
IDLitManipSurfContour::Init
PURPOSE:
The IDLitManipSurfContour::Init function method initializes
the object
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipSurfContour')
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPSURFCONTOUR::DOACTION
IDLITMANIPSURFCONTOUR::INIT, IDLITMANIPSURFCONTOUR::ONMOUSEDOWN
IDLITMANIPSURFCONTOUR::ONMOUSEMOTION, IDLITMANIPSURFCONTOUR::ONMOUSEUP
IDLITMANIPSURFCONTOUR::_CALCULATEANDSETLEVELVALUE
IDLITMANIPSURFCONTOUR::_FINDMANIPULATORTARGETS
[Previous]
[Next]
CLASS_NAME:
IDLitManipTranslate
PURPOSE:
Translate manipulator.
CATEGORY:
Components
SUPERCLASSES:
IDLitManipulator
SUBCLASSES:
CREATION:
See IDLitManipTranslate::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipTranslate::Init
IDLitManipTranslate::Cleanup
IDLitManipTranslate::
INTERFACES:
IIDLProperty
IIDLWindowEvent
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPTRANSLATE::CLEANUP, IDLITMANIPTRANSLATE::INIT
IDLITMANIPTRANSLATE::ONKEYBOARD, IDLITMANIPTRANSLATE::ONMOUSEDOWN
IDLITMANIPTRANSLATE::ONMOUSEMOTION, IDLITMANIPTRANSLATE::ONMOUSEUP
IDLITMANIPTRANSLATE::_CAPTUREMACROHISTORY
IDLITMANIPTRANSLATE::_DOREGISTERCURSOR
IDLITMANIPTRANSLATE::_FINDMANIPULATORTARGETS
IDLITMANIPTRANSLATE::_ONMOUSEDOWN, IDLITMANIPTRANSLATE::_TRANSLATE, UNIQ
[Previous]
[Next]
METHODNAME:
IDLitManipTranslate::Init
PURPOSE:
The IDLitManipTranslate::Init function method initializes the
Translate Manipulator component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oData = OBJ_NEW('IDLitManipTranslate', <manipulator type>)
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPTRANSLATE::CLEANUP, IDLITMANIPTRANSLATE::INIT
IDLITMANIPTRANSLATE::ONKEYBOARD, IDLITMANIPTRANSLATE::ONMOUSEDOWN
IDLITMANIPTRANSLATE::ONMOUSEMOTION, IDLITMANIPTRANSLATE::ONMOUSEUP
IDLITMANIPTRANSLATE::_CAPTUREMACROHISTORY
IDLITMANIPTRANSLATE::_DOREGISTERCURSOR
IDLITMANIPTRANSLATE::_FINDMANIPULATORTARGETS
IDLITMANIPTRANSLATE::_ONMOUSEDOWN, IDLITMANIPTRANSLATE::_TRANSLATE, UNIQ
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
CLASS_NAME:
IDLitManipulator
PURPOSE:
Abstract class for the manipulator system of the IDL component framework.
The class will not be created directly, but defines the basic
structure for the manipulator system.
CATEGORY:
Components
SUPERCLASSES:
IDLitComponent
_IDLitManipulator
CREATION:
See IDLitManipulator::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipulator::Init
IDLitManipulator::Cleanup
IDLitManipulator::
CALLS: ***
IDLITMANIPULATOR::CLEANUP, IDLITMANIPULATOR::GETPROPERTY
IDLITMANIPULATOR::INIT, IDLITMANIPULATOR::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitManipulatorContainer
PURPOSE:
Abstract class for the manipulator system of the IDL component framework.
The class will not be created directly, but defines the basic
structure for the manipulator container.
CATEGORY:
Components
SUPERCLASSES:
_IDLitManipulator
IDLitContainer
SUBCLASSES:
CREATION:
See IDLitManipulatorContainer::Init
METHODS:
Intrinsic Methods
This class has the following methods:
IDLitManipulatorContainer::Init
IDLitManipulatorContainer::Cleanup
IDLitManipulatorContainer::...
INTERFACES:
IIDLProperty
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITMANIPULATORCONTAINER::ADD
IDLITMANIPULATORCONTAINER::CLEANUP, IDLITMANIPULATORCONTAINER::GETCURRENT
IDLITMANIPULATORCONTAINER::GETCURRENTMANIPULATOR
IDLITMANIPULATORCONTAINER::GETCURSORTYPE
IDLITMANIPULATORCONTAINER::GETPROPERTY
IDLITMANIPULATORCONTAINER::GETSTATUSMESSAGE
IDLITMANIPULATORCONTAINER::GETWINDOWEVENTMASK
IDLITMANIPULATORCONTAINER::INIT
IDLITMANIPULATORCONTAINER::NOTIFYMANIPULATORCHANGE
IDLITMANIPULATORCONTAINER::ONKEYBOARD
IDLITMANIPULATORCONTAINER::ONMOUSEDOWN
IDLITMANIPULATORCONTAINER::ONMOUSEMOTION
IDLITMANIPULATORCONTAINER::ONMOUSEUP, IDLITMANIPULATORCONTAINER::REMOVE
IDLITMANIPULATORCONTAINER::RESIZESELECTIONVISUALS
IDLITMANIPULATORCONTAINER::SETCURRENT
IDLITMANIPULATORCONTAINER::SETCURRENTMANIPULATOR
IDLITMANIPULATORCONTAINER::SETPROPERTY
IDLITMANIPULATORCONTAINER::UPDATESELECTIONVISUALS
IDLITMANIPULATORCONTAINER::_AUTOSWITCH
IDLITMANIPULATORCONTAINER::_CYCLECURRENTTYPE
[Previous]
[Next]
CLASS_NAME:
IDLitManipulatorVisual
PURPOSE:
The IDLitManipulatorVisual class represents a collection of graphics
and/or other visualizations that as a group serve as a visual
representation for data.
CALLS: ***
IDLITMANIPULATORVISUAL::GETPROPERTY, IDLITMANIPULATORVISUAL::GETSUBHITTYPE
IDLITMANIPULATORVISUAL::INIT, IDLITMANIPULATORVISUAL::RESTORE
IDLITMANIPULATORVISUAL::SETPROPERTY
IDLITMANIPULATORVISUAL::_TRANSFORMTOVISUALIZATION
[Previous]
[Next]
CLASS_NAME:
IDLitManipViewZoom
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPVIEWZOOM::INIT, IDLITMANIPVIEWZOOM::ONMOUSEDOWN
IDLITMANIPVIEWZOOM::ONMOUSEMOTION, IDLITMANIPVIEWZOOM::ONMOUSEUP
IDLITMANIPVIEWZOOM::_CAPTUREMACROHISTORY
IDLITMANIPVIEWZOOM::_DOREGISTERCURSOR
[Previous]
[Next]
METHODNAME:
IDLitManipViewZoom::Init
PURPOSE:
The IDLitManipViewZoom::Init function method initializes the
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oManipulator = OBJ_NEW('IDLitManipViewZoom')
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITMANIPVIEWZOOM::INIT, IDLITMANIPVIEWZOOM::ONMOUSEDOWN
IDLITMANIPVIEWZOOM::ONMOUSEMOTION, IDLITMANIPVIEWZOOM::ONMOUSEUP
IDLITMANIPVIEWZOOM::_CAPTUREMACROHISTORY
IDLITMANIPVIEWZOOM::_DOREGISTERCURSOR
EXAMPLE:
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
IDLitManipVisImagePlane__Define
Purpose:
Defines the object structure for an IDLitManipVisImagePlane object.
CALLS: ***
IDLITMANIPVISIMAGEPLANE::CLEANUP, IDLITMANIPVISIMAGEPLANE::INIT
[Previous]
[Next]
IDLitManipVisRange__Define
Purpose:
Defines the object structure for an IDLitManipVisRange object.
CALLS: ***
IDLITMANIPVISRANGE::INIT, IDLITMANIPVISRANGE::_SETAXISOFFSETS
IDLITMANIPVISRANGE::_TRANSFORMTOVISUALIZATION
[Previous]
[Next]
IDLitManipVisRangePan__Define
Purpose:
Defines the object structure for an IDLitManipVisRangePan object.
CALLS: ***
FILEPATH, IDLITMANIPVISRANGEPAN::CLEANUP, IDLITMANIPVISRANGEPAN::INIT
IDLITMANIPVISRANGEPAN::SETPROPERTY, IDLITMANIPVISRANGEPAN::_LOADBITMAP
IDLITMANIPVISRANGEPAN::_TRANSFORMTOVISUALIZATION, READ_BMP
[Previous]
[Next]
IDLitManipVisRangeZoom__Define
Purpose:
Defines the object structure for an IDLitManipVisRangeZoom object.
CALLS: ***
FILEPATH, IDLITMANIPVISRANGEZOOM::CLEANUP, IDLITMANIPVISRANGEZOOM::INIT
IDLITMANIPVISRANGEZOOM::SETPROPERTY, IDLITMANIPVISRANGEZOOM::_LOADBITMAP
IDLITMANIPVISRANGEZOOM::_TRANSFORMTOVISUALIZATION, READ_BMP
[Previous]
[Next]
METHODNAME:
IDLitManipVisRotateAxis::_Update
PURPOSE:
This private procedure method updates the polygons and polylines.
CALLING SEQUENCE:
Obj->[IDLitManipVisRotateAxis::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitManipVisRotateAxis::Init followed by the word "Get"
can be retrieved using IDLitManipVisRotateAxis::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITMANIPVISROTATEAXIS::GETPROPERTY, IDLITMANIPVISROTATEAXIS::INIT
IDLITMANIPVISROTATEAXIS::SETPROPERTY, IDLITMANIPVISROTATEAXIS::_SHOW
IDLITMANIPVISROTATEAXIS::_UPDATE
[Previous]
[Next]
METHODNAME:
IDLitManipVisRotateAxis::GetProperty
PURPOSE:
The IDLitManipVisRotateAxis::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitManipVisRotateAxis::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitManipVisRotateAxis::Init followed by the word "Get"
can be retrieved using IDLitManipVisRotateAxis::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITMANIPVISROTATEAXIS::GETPROPERTY, IDLITMANIPVISROTATEAXIS::INIT
IDLITMANIPVISROTATEAXIS::SETPROPERTY, IDLITMANIPVISROTATEAXIS::_SHOW
IDLITMANIPVISROTATEAXIS::_UPDATE
[Previous]
[Next]
METHODNAME:
IDLitManipVisRotateAxis::SetProperty
PURPOSE:
The IDLitManipVisRotateAxis::SetProperty procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitManipVisRotateAxis::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitManipVisRotateAxis::Init followed by the word "Set"
can be set using IDLitManipVisRotateAxis::SetProperty.
CALLS: ***
IDLITMANIPVISROTATEAXIS::GETPROPERTY, IDLITMANIPVISROTATEAXIS::INIT
IDLITMANIPVISROTATEAXIS::SETPROPERTY, IDLITMANIPVISROTATEAXIS::_SHOW
IDLITMANIPVISROTATEAXIS::_UPDATE
[Previous]
[Next]
IDLitManipVisRotateAxis__Define
Purpose:
Defines the object structure for an IDLitManipVisRotateAxis object.
CALLS: ***
IDLITMANIPVISROTATEAXIS::GETPROPERTY, IDLITMANIPVISROTATEAXIS::INIT
IDLITMANIPVISROTATEAXIS::SETPROPERTY, IDLITMANIPVISROTATEAXIS::_SHOW
IDLITMANIPVISROTATEAXIS::_UPDATE
[Previous]
[Next]
IDLitManipVisScale2D__Define
Purpose:
Defines the object structure for an IDLitManipVisScale2D object.
CALLS: ***
IDLITMANIPVISSCALE2D::CLEANUP, IDLITMANIPVISSCALE2D::INIT
[Previous]
[Next]
IDLitManipVisScale3D__Define
Purpose:
Defines the object structure for an IDLitManipVisScale3D object.
CALLS: ***
IDLITMANIPVISSCALE3D::INIT
[Previous]
[Next]
IDLitManipVisScale__Define
Purpose:
Defines the object structure for an IDLitManipVisScale object.
CALLS: ***
IDLITMANIPVISSCALE::GETSUBHITTYPE, IDLITMANIPVISSCALE::INIT
IDLITMANIPVISSCALE::SET3D
[Previous]
[Next]
IDLitManipVisSelect__Define
Purpose:
Defines the object structure for an IDLitManipVisSelect object.
CALLS: ***
IDLITMANIPVISSELECT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitManipVisSelectBox
PURPOSE:
The IDLitManipVisSelectBox class is the selection visual.
CATEGORY:
Components
SUPERCLASSES:
IDLgrModel
CALLS: ***
IDLITMANIPVISSELECTBOX::GETPROPERTY, IDLITMANIPVISSELECTBOX::INIT
IDLITMANIPVISSELECTBOX::SET3D, IDLITMANIPVISSELECTBOX::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitManipVisSelectBox::Init
PURPOSE:
The IDLitManipVisSelectBox::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipVisSelectBox')
or
Obj->[IDLitManipVisSelectBox::]Init
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITMANIPVISSELECTBOX::GETPROPERTY, IDLITMANIPVISSELECTBOX::INIT
IDLITMANIPVISSELECTBOX::SET3D, IDLITMANIPVISSELECTBOX::SETPROPERTY
[Previous]
[Next]
IDLitManipVisSelectBox__Define
Purpose:
Defines the object structure for an IDLitManipVisSelectBox object.
CALLS: ***
IDLITMANIPVISSELECTBOX::GETPROPERTY, IDLITMANIPVISSELECTBOX::INIT
IDLITMANIPVISSELECTBOX::SET3D, IDLITMANIPVISSELECTBOX::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitManipVisSphere
PURPOSE:
The IDLitManipVisSphere class is the sphere selection visual.
CATEGORY:
Components
SUPERCLASSES:
IDLgrModel
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
METHODNAME:
IDLitManipVisSphere::Init
PURPOSE:
The IDLitManipVisSphere::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipVisSphere')
or
Obj->[IDLitManipVisSphere::]Init
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
METHODNAME:
IDLitManipVisSphere::Cleanup
PURPOSE:
The IDLitManipVisSphere::Cleanup procedure method preforms all cleanup
on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitManipVisSphere::]Cleanup
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
METHODNAME:
IDLitManipVisSphere::GetProperty
PURPOSE:
The IDLitManipVisSphere::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitManipVisSphere::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitManipVisSphere::Init followed by the word "Get"
can be retrieved using IDLitManipVisSphere::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
METHODNAME:
IDLitManipVisSphere::SetProperty
PURPOSE:
The IDLitManipVisSphere::SetProperty procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitManipVisSphere::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitManipVisSphere::Init followed by the word "Set"
can be set using IDLitManipVisSphere::SetProperty.
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
IDLitManipVisSphere__Define
Purpose:
Defines the object structure for an IDLitManipVisSphere object.
CALLS: ***
IDLITMANIPVISSPHERE::CLEANUP, IDLITMANIPVISSPHERE::GETPROPERTY
IDLITMANIPVISSPHERE::INIT, IDLITMANIPVISSPHERE::SETPROPERTY, MESH_OBJ
[Previous]
[Next]
CLASS_NAME:
IDLitManipVisVertex
PURPOSE:
The IDLitManipVisVertex class is the vertex manipulator visual.
CATEGORY:
Components
SUPERCLASSES:
IDLgrModel
SUBCLASSES:
CREATION:
See IDLitManipVisVertex::Init
METHODS:
Intrinsic Methods
IDLitManipVisVertex::Init
IDLitManipVisVertex::Cleanup
IDLitManipVisVertex::_TransformToVisualization
CALLS: ***
IDLITMANIPVISVERTEX::CLEANUP, IDLITMANIPVISVERTEX::INIT
IDLITMANIPVISVERTEX::_TRANSFORMTOVISUALIZATION
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
[Previous]
[Next]
METHODNAME:
IDLitManipVisVertex::Init
PURPOSE:
The IDLitManipVisVertex::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitManipVisVertex')
or
Obj->[IDLitManipVisVertex::]Init
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITMANIPVISVERTEX::CLEANUP, IDLITMANIPVISVERTEX::INIT
IDLITMANIPVISVERTEX::_TRANSFORMTOVISUALIZATION
[Previous]
[Next]
IDLitManipVisVertex__Define
Purpose:
Defines the object structure for an IDLitManipVisVertex object.
CALLS: ***
IDLITMANIPVISVERTEX::CLEANUP, IDLITMANIPVISVERTEX::INIT
IDLITMANIPVISVERTEX::_TRANSFORMTOVISUALIZATION
[Previous]
[Next]
IDLitManipVisView__Define
Purpose:
Defines the object structure for an IDLitManipVisView object.
CALLS: ***
IDLITMANIPVISVIEW::INIT, IDLITMANIPVISVIEW::_INSERTHIGHLIGHT
IDLITMANIPVISVIEW::_SELECT, IDLITMANIPVISVIEW::_UPDATEVISUALTYPES
[Previous]
[Next]
CLASS_NAME:
IDLitMessage
PURPOSE:
Generic message object. Fairly abstract, only providing a base
class for messaging operations between elements of the
tool. Primarly intended for the communication between the Tool
and external intities.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitMessage::Init
METHODS:
This class has the following methods:
IDLitMessage::Init
IDLitMessage::Cleanup
IDLitMessage::GetProperty
IDLitMessage::SetProperty
INTERFACES:
IDLitMessage
CALLS: ***
IDLITMESSAGE::CLEANUP, IDLITMESSAGE::GETPROPERTY
IDLITMESSAGE::GETTEXTMESSAGE, IDLITMESSAGE::GETTYPE, IDLITMESSAGE::INIT
IDLITMESSAGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitMsgProgress
PURPOSE:
Progress message object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitMessage
SUBCLASSES:
CREATION:
See IDLitMsgProgress::Init
METHODS:
This class has the following methods:
IDLitMsgProgress::Init
IDLitMsgProgress::Cleanup
IDLitMsgProgress::GetProperty
IDLitMsgProgress::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITMSGPROGRESS::GETPROPERTY, IDLITMSGPROGRESS::INIT
IDLITMSGPROGRESS::ISDONE, IDLITMSGPROGRESS::RESET
IDLITMSGPROGRESS::SETPROPERTY, IDLITMSGPROGRESS::SHUTDOWN
[Previous]
[Next]
CLASS_NAME:
IDLitNotifier
PURPOSE:
Implements the subject-observer methods.
SUPERCLASSES:
IDLitComponent
IDL_Container
INTERFACES:
This component exposes the following interfaces:
IIDLProperty
IIDLNotifier
IIDLContainer
METHODS:
This class has the following intrinsic methods:
IDLitNotifier::Cleanup
IDLitNotifier::Init
IDLitNotifier::GetProperty
IDLitNotifier::Notify
IDLitNotifier::SetProperty
IDLitNotifier::Add
This class inherits the following methods:
IDL_Container::Count
IDL_Container::Get
IDL_Container::IsContained
IDL_Container::Move
IDLitComponent::QueryProperty
IDLitComponent::RegisterProperty
IDL_Container::Remove
PROPERTIES:
This class has the following properties:
CALLBACK
NOTIFY
CALLS: ***
IDLITNOTIFIER::ADD, IDLITNOTIFIER::CLEANUP, IDLITNOTIFIER::GETPROPERTY
IDLITNOTIFIER::INIT, IDLITNOTIFIER::NOTIFY, IDLITNOTIFIER::SETPROPERTY
MODIFICATION HISTORY:
Written by: CT, RSI, March 2001.
[Previous]
[Next]
CLASS_NAME:
IDLitObjDesc
PURPOSE:
This file implements the IDLitObjDesc class. This class provides
an object descriptor that allows object registration without the
need to instatiated an actual destination object.
The object also provides a method to create the target object.
This class also provides a method to emulate the property set of
the object it represents. This is done by using the property bag
class that is part of the framework. Using a lazying approach,
this class will create the object and record it's property
set. This is done in the following situations:
- The object instance is requested.
- When a property is retrieved or set and this class doesn't
know about that property.
- When the list of avaliable properties for this class is
requested.
After the property set has been recorded, this object can proxy
the property set. If this isn't a singleton class, this allows
for the setting of tool scoped values that are then applied
when a new object is requested. This provides a "style" like sytem.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
IDLitPropertyBag
CREATION:
See IDLitObjDesc::Init
METHODS:
This class has the following methods:
IDLitObjDesc::Init
IDLitObjDesc::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOBJDESC::CLEANUP, IDLITOBJDESC::EDITUSERDEFPROPERTY
IDLITOBJDESC::GETOBJECTINSTANCE, IDLITOBJDESC::GETPROPERTY
IDLITOBJDESC::INIT, IDLITOBJDESC::ONNOTIFY
IDLITOBJDESC::RETURNOBJECTINSTANCE, IDLITOBJDESC::SETPROPERTY
IDLITOBJDESC::_GETALLPROPERTYDESCRIPTORS
IDLITOBJDESC::_INITIALIZEPROPERTYBAG, IDLITOBJDESC::_INSTANTIATEOBJECT
[Previous]
[Next]
CLASS_NAME:
IDLitObjDescTool
PURPOSE:
This file implements the IDLitObjDescMacro class. This class provides
an object descriptor that allows object registration without the
need to instatiated an actual destination object.
The object also provides a method to create the target object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitObjDescTool::Init
CALLS: ***
IDLITOBJDESCMACRO::GETPROPERTY, IDLITOBJDESCMACRO::INIT
IDLITOBJDESCMACRO::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitObjDesc
PURPOSE:
This file implements the IDLitObjDesc class. This class provides
an object descriptor that allows object registration without the
need to instatiated an actual destination object.
The object also provides a method to create the target object.
This class also provides a method to emulate the property set of
the object it represents. This is done by using the property bag
class that is part of the framework. Using a lazying approach,
this class will create the object and record it's property
set. This is done in the following situations:
- The object instance is requested.
- When a property is retrieved or set and this class doesn't
know about that property.
- When the list of avaliable properties for this class is
requested.
After the property set has been recorded, this object can proxy
the property set. If this isn't a singleton class, this allows
for the setting of tool scoped values that are then applied
when a new object is requested. This provides a "style" like sytem.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
IDLitPropertyBag
CREATION:
See IDLitObjDesc::Init
METHODS:
This class has the following methods:
IDLitObjDesc::Init
IDLitObjDesc::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITBASENAME, IDLITOBJDESCPROXY::CLEANUP
IDLITOBJDESCPROXY::EDITUSERDEFPROPERTY, IDLITOBJDESCPROXY::GETDATATYPES
IDLITOBJDESCPROXY::GETOBJECTINSTANCE, IDLITOBJDESCPROXY::GETPROPERTY
IDLITOBJDESCPROXY::INIT, IDLITOBJDESCPROXY::ONNOTIFY
IDLITOBJDESCPROXY::QUERYAVAILABILITY
IDLITOBJDESCPROXY::RETURNOBJECTINSTANCE, IDLITOBJDESCPROXY::SETPROPERTY
IDLITOBJDESCPROXY::_GETALLPROPERTYDESCRIPTORS
IDLITOBJDESCPROXY::_GETPROXYTARGET
[Previous]
[Next]
CLASS_NAME:
IDLitObjDescROI
PURPOSE:
This file implements the IDLitObjDescROI class. This class provides
an object descriptor that allows ROI object registration without the
need to instatiate an actual destination object.
CALLS: ***
IDLITOBJDESCROI::INIT, IDLITOBJDESCROI::_INSTANTIATEOBJECT
[Previous]
[Next]
METHODNAME:
IDLitObjDescROI::Init
PURPOSE:
This function method initializes the component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitObjDescROI')
or
Obj->[IDLitObjDescROI::]Init
KEYWORD PARAMETERS:
ROI_TYPE: Set this keyword to an integer that indicates the
type of ROI that this descriptor refers to. Valid values include:
0 = Points
1 = Path
2 = Closed Polygon (default)
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITOBJDESCROI::INIT, IDLITOBJDESCROI::_INSTANTIATEOBJECT
[Previous]
[Next]
CLASS_NAME:
IDLitObjDescTool
PURPOSE:
This file implements the IDLitObjDescTool class. This class provides
an object descriptor that allows object registration without the
need to instatiated an actual destination object.
The object also provides a method to create the target object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitObjDescTool::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOBJDESCTOOL::CLEANUP
IDLITOBJDESCTOOL::GETOBJECTINSTANCE, IDLITOBJDESCTOOL::GETPROPERTY
IDLITOBJDESCTOOL::INIT, IDLITOBJDESCTOOL::QUERYAVAILABILITY
IDLITOBJDESCTOOL::RETURNOBJECTINSTANCE, IDLITOBJDESCTOOL::SETPROPERTY
IDLITOBJDESCTOOL::_INSTANTIATEOBJECT, IDLITOBJDESCTOOL::_SETTOOL
[Previous]
[Next]
CLASS_NAME:
IDLitObjDescVis
PURPOSE:
This file implements the IDLitObjDescVis class. This class provides
an object descriptor that allows visualization object registration without the
need to instatiated an actual destination object.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitObjDesc
SUBCLASSES:
CREATION:
See IDLitObjDescVis::Init
METHODS:
This class has the following methods:
IDLitObjDescVis::Init
IDLitObjDescVis::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOBJDESCVIS::CLEANUP, IDLITOBJDESCVIS::GETDATATYPES
IDLITOBJDESCVIS::GETOBJECTINSTANCE
[Previous]
[Next]
CLASS_NAME:
IDLitopAnnotation
PURPOSE:
This file implements the operation that is used to set the scale
factor on a visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopAnnotation::Init
METHODS:
This class has the following methods:
CALLS: ***
IDLITLANGCATQUERY, IDLITOPANNOTATION::INIT
IDLITOPANNOTATION::RECORDFINALVALUES
IDLITOPANNOTATION::RECORDINITIALVALUES, IDLITOPANNOTATION::REDOOPERATION
IDLITOPANNOTATION::UNDOOPERATION
[Previous]
[Next]
CLASS_NAME:
IDLitopBrowserData
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopBrowserData::Init
CALLS: ***
IDLITOPBROWSERDATA::DOACTION, IDLITOPBROWSERDATA::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopBrowserManip
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopBrowserManip::Init
CALLS: ***
IDLITOPBROWSERMANIP::DOACTION, IDLITOPBROWSERMANIP::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopBrowserOperation
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopBrowserOperation::Init
METHODS:
This class has the following methods:
IDLitopBrowserOperation::Init
IDLitopBrowserOperation::GetProperty
IDLitopBrowserOperation::SetProperty
IDLitopBrowserOperation::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPBROWSEROPERATION::DOACTION, IDLITOPBROWSEROPERATION::GETPROPERTY
IDLITOPBROWSEROPERATION::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitBrowserPrefs
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitBrowserPrefs::Init
CALLS: ***
IDLITOPBROWSERPREFS::DOACTION, IDLITOPBROWSERPREFS::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopBrowserTool
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopBrowserTool::Init
CALLS: ***
IDLITOPBROWSERTOOL::DOACTION, IDLITOPBROWSERTOOL::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopBrowserVis
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopBrowserVis::Init
CALLS: ***
IDLITOPBROWSERVIS::DOACTION, IDLITOPBROWSERVIS::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopBytscl
PURPOSE:
Implements the Byte Scale operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPBYTSCL::DOEXECUTEUI, IDLITOPBYTSCL::EXECUTE
IDLITOPBYTSCL::GETPROPERTY, IDLITOPBYTSCL::INIT, IDLITOPBYTSCL::SETPROPERTY
IDLITOPBYTSCL::_EXECUTEONDATA
[Previous]
[Next]
CLASS_NAME:
IDLitopCLExport
PURPOSE:
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopCLExport::Init
METHODS:
This class has the following methods:
IDLitopCLExport::Init
IDLitopCLExport::Cleanup
IDLitopCLExport::GetProperty
IDLitopCLExport::SetProperty
IDLitopCLExport::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPCLEXPORT::CLEANUP, IDLITOPCLEXPORT::DOACTION
IDLITOPCLEXPORT::GETPROPERTY, IDLITOPCLEXPORT::INIT
IDLITOPCLEXPORT::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopClipCopy
PURPOSE:
This file implements the operation that will copy the currently
selected items to the local clipboard.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopClipCopy::Init
CALLS: ***
IDLITOPCLIPCOPY::DOACTION, IDLITOPCLIPCOPY::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitClipCut
PURPOSE:
This file implements the operation that will cut the currently
selected items to the local clipboard.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitClipCut::Init
METHODS:
This class has the following methods:
IDLitClipCut::Init
IDLitClipCut::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPCLIPCUT::DOACTION, IDLITOPCLIPCUT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopClipPaste
PURPOSE:
Implements the local clipboard paste operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopClipPaste::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPCLIPPASTE::DOACTION, IDLITOPCLIPPASTE::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopClipPasteSpecial
PURPOSE:
Implements the local clipboard paste special operation. This
operation differs from paste in that it tries to use the original
data reference and not a copy.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopClipPasteSpecial::Init
CALLS: ***
IDLITOPCLIPPASTESPECIAL::DOACTION, IDLITOPCLIPPASTESPECIAL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopCurveFitting
PURPOSE:
This file implements the Curve Fitting action.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitOperation
SUBCLASSES:
CREATION:
See IDLitopCurveFitting::Init
CALLS: ***
CURVEFIT, GAUSSFIT, IDLITOPCURVEFITTING::CLEANUP
IDLITOPCURVEFITTING::DOACTION, IDLITOPCURVEFITTING::GETMODELS
IDLITOPCURVEFITTING::GETPROPERTY, IDLITOPCURVEFITTING::INIT
IDLITOPCURVEFITTING::SETPROPERTY, IDLITOPCURVEFITTING::_CURVEFIT
IDLITOPCURVEFITTING::_EXECUTEONDATA, IDLITOPCURVEFITTING::_EXECUTEONTARGET
IDLITOPCURVEFITTING_EXPONENTIAL, IDLITOPCURVEFITTING_GEOMETRIC
IDLITOPCURVEFITTING_GOMPERTZ, IDLITOPCURVEFITTING_HYPERBOLIC
IDLITOPCURVEFITTING_HYPERBOLICTRIGONOMETRIC, IDLITOPCURVEFITTING_LOGISTIC
IDLITOPCURVEFITTING_LOGSQUARE, IDLITOPCURVEFITTING_TRIGONOMETRICPRODUCT
IDLITOPCURVEFITTING_TRIGONOMETRICSUMMATION
IDLITOPCURVEFITTING_VARIABLESINC, POLY_FIT
[Previous]
[Next]
CLASS_NAME:
IDLitOperation
PURPOSE:
This file implements the abstract operation component.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitOperation::Init
CALLS: ***
IDLITOPERATION::CLEANUP, IDLITOPERATION::CREATE, IDLITOPERATION::DOACTION
IDLITOPERATION::GETPROPERTY, IDLITOPERATION::INIT
IDLITOPERATION::QUERYAVAILABILITY, IDLITOPERATION::RECORDFINALPROPERTIES
IDLITOPERATION::RECORDFINALVALUES, IDLITOPERATION::RECORDINITIALPROPERTIES
IDLITOPERATION::RECORDINITIALVALUES, IDLITOPERATION::REDOOPERATION
IDLITOPERATION::SETPROPERTY, IDLITOPERATION::SHUTDOWN
IDLITOPERATION::UNDOOPERATION, IDLITOPERATION::_CURRENTAVAILABILITY
[Previous]
[Next]
CLASS_NAME:
IDLitopExportData
PURPOSE:
This class implements an operation that is used to run the export
data wizard.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopExportData::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPEXPORTDATA::DOACTION
IDLITOPEXPORTDATA::EDITUSERDEFPROPERTY, IDLITOPEXPORTDATA::GETFILTERLIST
IDLITOPEXPORTDATA::GETPROPERTY, IDLITOPEXPORTDATA::INIT
IDLITOPEXPORTDATA::SETPROPERTY, IDLITOPEXPORTDATA::_EXPORTTOFILE
IDLITOPEXPORTDATA::_EXPORTTOVARIABLE
[Previous]
[Next]
CLASS_NAME:
IDLitopFileExit
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopFileExit::Init
METHODS:
This class has the following methods:
IDLitopFileExit::Init
IDLitopFileExit::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPFILEEXIT::DOACTION, IDLITOPFILEEXIT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopFilePrint
PURPOSE:
This file implements the File/Print action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopFilePrint::Init
CALLS: ***
IDLITOPFILEPRINT::DOACTION, IDLITOPFILEPRINT::GETPROPERTY
IDLITOPFILEPRINT::INIT, IDLITOPFILEPRINT::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopFilterRoberts
PURPOSE:
Implements the Roberts operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPFILTERROBERTS::CLEANUP, IDLITOPFILTERROBERTS::EXECUTE
IDLITOPFILTERROBERTS::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopFilterSobel
PURPOSE:
Implements the Sobel operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPFILTERSOBEL::CLEANUP, IDLITOPFILTERSOBEL::EXECUTE
IDLITOPFILTERSOBEL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopGridData
PURPOSE:
This file implements the operation object that is used to grid data.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopGridData::Init
METHODS:
This class has the following methods:
IDLitopGridData::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPGRIDDATA::GETPROPERTY, IDLITOPGRIDDATA::GRID, IDLITOPGRIDDATA::INIT
IDLITOPGRIDDATA::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopHelpAbout
PURPOSE:
Simple op to relay a call to "help about"
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopHelpAbout::Init
CALLS: ***
IDLITOPHELPABOUT::DOACTION
[Previous]
[Next]
CLASS_NAME:
IDLitopHistogram
PURPOSE:
This file implements the Histogram action.
CALLS: ***
IDLITOPHISTOGRAM::CLEANUP, IDLITOPHISTOGRAM::DOACTION
IDLITOPHISTOGRAM::INIT, IDLITOPHISTOGRAM::_EXECUTEONDATA
IDLITOPHISTOGRAM::_EXECUTEONROI, IDLITOPHISTOGRAM::_EXECUTEONTARGET
IDLitsys_CreateTool
[Previous]
[Next]
CLASS_NAME:
IDLitopImagePlaneIImage
PURPOSE:
This operation launches an instance of the iImage tool
using a currently selected image plane.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopImagePlaneIImage::Init
CALLS: ***
IDLITOPIMAGEPLANEIIMAGE::DOACTION, IDLITOPIMAGEPLANEIIMAGE::INIT
IDLitsys_CreateTool
[Previous]
[Next]
CLASS_NAME:
IDLitopImportData
PURPOSE:
This class implements an operation that is used to run the import
data wizard.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopImportData::Init
METHODS:
This class has the following methods:
IDLitopImportData::Init
IDLitopImportData::Cleanup
IDLitopImportData::GetProperty
IDLitopImportData::SetProperty
IDLitopImportData::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPIMPORTDATA::CLEANUP, IDLITOPIMPORTDATA::DOACTION
IDLITOPIMPORTDATA::INIT, IDLITOPIMPORTDATA::SETIMPORTPARAMETERS
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertAxis
PURPOSE:
This file implements the insert Axis operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertAxis::Init
METHODS:
This class has the following methods:
IDLitopInsertAxis::Init
IDLitopInsertAxis::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPINSERTAXIS::DOACTION, IDLITOPINSERTAXIS::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertColorbar
PURPOSE:
This operation creates a colorbar visualization for selected objects.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertColorbar::Init
METHODS:
This class has the following methods:
IDLitopInsertColorbar::Init
IDLitopInsertColorbar::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPINSERTCOLORBAR::DOACTION
IDLITOPINSERTCOLORBAR::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertContour
PURPOSE:
This file implements the generic IDL Tool object that
implements the Insert/Contour action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertContour::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPINSERTCONTOUR::DOACTION
IDLITOPINSERTCONTOUR::GETPROPERTY, IDLITOPINSERTCONTOUR::INIT
IDLITOPINSERTCONTOUR::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertDataSpace
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertDataSpace::Init
METHODS:
This class has the following methods:
IDLitopInsertDataSpace::Init
IDLitopInsertDataSpace::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPINSERTDATASPACE::DOACTION
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertImage
PURPOSE:
This file implements the generic IDL Tool object that
implements the Operations/Image action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertImage::Init
METHODS:
This class has the following methods:
IDLitopInsertImage::Init
IDLitopInsertImage::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPINSERTIMAGE::DOACTION, IDLITOPINSERTIMAGE::INIT
IDLITOPINSERTIMAGE::REDOOPERATION, IDLITOPINSERTIMAGE::_MOVEBEHIND
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertImagePlane
PURPOSE:
This file implements the generic IDL Tool object that
implements the Insert/ImagePlane action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertImagePlane::Init
METHODS:
This class has the following methods:
IDLitopInsertImagePlane::Init
IDLitopInsertImagePlane::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPINSERTIMAGEPLANE::DOACTION, IDLITOPINSERTIMAGEPLANE::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertMapGrid
PURPOSE:
This operation creates a map grid visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertMapGrid::Init
CALLS: ***
IDLITOPINSERTMAPGRID::DOACTION, IDLITOPINSERTMAPGRID::INIT
IDLITOPINSERTMAPGRID::REDOOPERATION
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertMapShape
PURPOSE:
This operation creates a map grid visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopInsertMapShape::Init
CALLS: ***
FILEPATH, IDLITLANGCATQUERY, IDLITOPINSERTMAPSHAPE::DOACTION
IDLITOPINSERTMAPSHAPE::GETPROPERTY, IDLITOPINSERTMAPSHAPE::INIT
IDLITOPINSERTMAPSHAPE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopInsertSurface
PURPOSE:
This file implements the generic IDL Tool object that
implements the Insert/Surface action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CALLS: ***
IDLITLANGCATQUERY, IDLITOPINSERTSURFACE::DOACTION
IDLITOPINSERTSURFACE::INIT, IDLITOPINSERTSURFACE::QUERYAVAILABILITY
[Previous]
[Next]
CLASS_NAME:
IDLitopIntVol
PURPOSE:
This operation creates an Interval Volume for a volume.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitopIsoSurface
SUBCLASSES:
CREATION:
See IDLitopIntVol::Init
CALLS: ***
IDLITOPINTVOL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopInvert
PURPOSE:
Implements an image invert operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPINVERT::CLEANUP, IDLITOPINVERT::EXECUTE, IDLITOPINVERT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopIsoSurface
PURPOSE:
This operation creates an isosurface for a volume.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitOperation
SUBCLASSES:
CREATION:
See IDLitopIsoSurface::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPISOSURFACE::CLEANUP, IDLITOPISOSURFACE::DOACTION
IDLITOPISOSURFACE::GETPROPERTY, IDLITOPISOSURFACE::INIT
IDLITOPISOSURFACE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopLineProfile
PURPOSE:
This file implements the operation invoked by the line profile
manipulator to obtain cursor input and determine endpoints for
a line profile visualization. It then launches the plot profile
operation to take the specified endpoints and actually create
the line profile visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopLineProfile::Init
METHODS:
This class has the following methods:
IDLitopLineProfile::Init
IDLitopLineProfile::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPLINEPROFILE::DOACTION, IDLITOPLINEPROFILE::GETPROPERTY
IDLITOPLINEPROFILE::INIT, IDLITOPLINEPROFILE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroDelay
PURPOSE:
This file implements the operation that changes the range
of the current data spaces. It is for use in macros
and history when a user uses the range box, range pan or
range zoom manipulators.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroDelay::Init
METHODS:
This class has the following methods:
IDLitopMacroDelay::Init
IDLitopMacroDelay::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACRODELAY::DOACTION, IDLITOPMACRODELAY::GETPROPERTY
IDLITOPMACRODELAY::INIT, IDLITOPMACRODELAY::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroEditor
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when an object browser is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroEditor::Init
CALLS: ***
IDLITOPMACROEDITOR::DOACTION, IDLITOPMACROEDITOR::GETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroRangeChange
PURPOSE:
This file implements the operation that changes the range
of the current data spaces. It is for use in macros
and history when a user uses the range box, range pan or
range zoom manipulators.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroRangeChange::Init
METHODS:
This class has the following methods:
IDLitopMacroRangeChange::Init
IDLitopMacroRangeChange::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACRORANGECHANGE::DOACTION, IDLITOPMACRORANGECHANGE::GETPROPERTY
IDLITOPMACRORANGECHANGE::INIT, IDLITOPMACRORANGECHANGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroRecordStart
PURPOSE:
This file implements the start recording macro operation for the IDL Tool system
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
METHODS:
This class has the following methods:
IDLitopMacroRecordStart::Init
IDLitopMacroRecordStart::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACRORECORDSTART::DOACTION, IDLITOPMACRORECORDSTART::GETPROPERTY
IDLITOPMACRORECORDSTART::INIT, IDLITOPMACRORECORDSTART::QUERYAVAILABILITY
IDLITOPMACRORECORDSTART::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroRecordStop
PURPOSE:
This file implements the stop recording macro operation for the IDL Tool system
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
METHODS:
This class has the following methods:
IDLitopMacroRecordStop::Init
IDLitopMacroRecordStop::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACRORECORDSTOP::DOACTION, IDLITOPMACRORECORDSTOP::GETPROPERTY
IDLITOPMACRORECORDSTOP::INIT, IDLITOPMACRORECORDSTOP::QUERYAVAILABILITY
IDLITOPMACRORECORDSTOP::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroRotate
PURPOSE:
This file implements the operation that translates visualizations
in the current window's current view. It is for use in macros
and history when a user uses the rotate manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroRotate::Init
METHODS:
This class has the following methods:
IDLitopMacroRotate::Init
IDLitopMacroRotate::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDENTITY, IDLITOPMACROROTATE::DOACTION, IDLITOPMACROROTATE::GETPROPERTY
IDLITOPMACROROTATE::INIT, IDLITOPMACROROTATE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroScale
PURPOSE:
This file implements the operation that scales visualizations
in the current windows current view. It is for use in macros
and history when a user uses the scale manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroScale::Init
METHODS:
This class has the following methods:
IDLitopMacroScale::Init
IDLitopMacroScale::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACROSCALE::DOACTION, IDLITOPMACROSCALE::GETPROPERTY
IDLITOPMACROSCALE::INIT, IDLITOPMACROSCALE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroStepDelayChange
PURPOSE:
This file implements the operation that changes the range
of the current data spaces. It is for use in macros
and history when a user uses the range box, range pan or
range zoom manipulators.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroStepDelayChange::Init
METHODS:
This class has the following methods:
IDLitopMacroStepDelayChange::Init
IDLitopMacroStepDelayChange::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACROSTEPDELAYCHANGE::DOACTION
IDLITOPMACROSTEPDELAYCHANGE::GETPROPERTY
IDLITOPMACROSTEPDELAYCHANGE::INIT
IDLITOPMACROSTEPDELAYCHANGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroStepDisplayChange
PURPOSE:
This file implements the operation that changes the range
of the current data spaces. It is for use in macros
and history when a user uses the range box, range pan or
range zoom manipulators.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroStepDisplayChange::Init
METHODS:
This class has the following methods:
IDLitopMacroStepDisplayChange::Init
IDLitopMacroStepDisplayChange::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACROSTEPDISPLAYCHANGE::DOACTION
IDLITOPMACROSTEPDISPLAYCHANGE::GETPROPERTY
IDLITOPMACROSTEPDISPLAYCHANGE::INIT
IDLITOPMACROSTEPDISPLAYCHANGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroTranslate
PURPOSE:
This file implements the operation that translates visualizations
in the current windows current view. It is for use in macros
and history when a user uses the translate manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroTranslate::Init
METHODS:
This class has the following methods:
IDLitopMacroTranslate::Init
IDLitopMacroTranslate::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACROTRANSLATE::DOACTION, IDLITOPMACROTRANSLATE::GETPROPERTY
IDLITOPMACROTRANSLATE::INIT, IDLITOPMACROTRANSLATE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroViewPan
PURPOSE:
This file implements the operation that pans
the current window's current view. It is for use in macros
and history when a user uses the view pan manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroViewPan::Init
METHODS:
This class has the following methods:
IDLitopMacroViewPan::Init
IDLitopMacroViewPan::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITOPMACROVIEWPAN::DOACTION, IDLITOPMACROVIEWPAN::DOPAN
IDLITOPMACROVIEWPAN::ENDPAN, IDLITOPMACROVIEWPAN::GETPROPERTY
IDLITOPMACROVIEWPAN::INIT, IDLITOPMACROVIEWPAN::RECORDUNDOVALUES
IDLITOPMACROVIEWPAN::SETPROPERTY, IDLITOPMACROVIEWPAN::STARTPAN
[Previous]
[Next]
CLASS_NAME:
IDLitopMacroZoom
PURPOSE:
This file implements the operation that zooms visualizations
in the current window's current view. It is for use in macros
and history when a user uses the view zoom manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMacroZoom::Init
METHODS:
This class has the following methods:
IDLitopMacroZoom::Init
IDLitopMacroZoom::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPMACROZOOM::DOACTION, IDLITOPMACROZOOM::GETPROPERTY
IDLITOPMACROZOOM::INIT, IDLITOPMACROZOOM::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopMapLimit
PURPOSE:
This file implements the Map Limit action. This is used by the
map panel to change the longitude/latitude min or max.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMapLimit::Init
CALLS: ***
IDLITOPMAPLIMIT::DOACTION, IDLITOPMAPLIMIT::GETPROPERTY
IDLITOPMAPLIMIT::INIT, IDLITOPMAPLIMIT::REDOOPERATION
IDLITOPMAPLIMIT::SETPROPERTY, IDLITOPMAPLIMIT::UNDOOPERATION
IDLITOPMAPLIMIT::_UNDOREDOOPERATION
[Previous]
[Next]
CLASS_NAME:
IDLitopMapProjection
PURPOSE:
This file implements the IDL Tool object that
implements the Map Projection action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMapProjection::Init
CALLS: ***
IDLITOPMAPPROJECTION::DOACTION, IDLITOPMAPPROJECTION::GETPROPERTY
IDLITOPMAPPROJECTION::INIT, IDLITOPMAPPROJECTION::REDOOPERATION
IDLITOPMAPPROJECTION::SETPROPERTY, IDLITOPMAPPROJECTION::UNDOOPERATION
[Previous]
[Next]
CLASS_NAME:
IDLitopMapRegisterImage
PURPOSE:
This file implements the IDL Tool object that
implements the Map Projection action.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopMapRegisterImage::Init
CALLS: ***
IDLITOPMAPREGISTERIMAGE::CLEANUP, IDLITOPMAPREGISTERIMAGE::DOACTION
IDLITOPMAPREGISTERIMAGE::EDITUSERDEFPROPERTY
IDLITOPMAPREGISTERIMAGE::GETPREVIEW, IDLITOPMAPREGISTERIMAGE::GETPROPERTY
IDLITOPMAPREGISTERIMAGE::INIT, IDLITOPMAPREGISTERIMAGE::SETPROPERTY
IDLITOPMAPREGISTERIMAGE::_GETGEOTIFFOBJ
IDLITOPMAPREGISTERIMAGE::_GETMAPPROJECTION
IDLITOPMAPREGISTERIMAGE::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitopNewTool
PURPOSE:
This file implements a new tool operation. This will create a new
tool at a given location.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopNewTool::Init
METHODS:
This class has the following methods:
CALLS: ***
IDLITOPNEWTOOL::DOACTION, IDLITOPNEWTOOL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopOrder
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopOrder::Init
METHODS:
This class has the following methods:
IDLitopOrder::Init
IDLitopOrder::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPORDER::DOACTION, IDLITOPORDER::INIT, IDLITOPORDER::REDOOPERATION
IDLITOPORDER::UNDOOPERATION, IDLITOPORDER::_UNDOREDO
[Previous]
[Next]
CLASS_NAME:
IDLitopPlotProfile
PURPOSE:
This file implements the operation that takes endpoints supplied
by the line profile manipulator and operation and creates a plot.
The plot represents the data of the selected visualization at the
location specified by the manipulator.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopPlotProfile::Init
METHODS:
This class has the following methods:
IDLitopPlotProfile::Init
IDLitopPlotProfile::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPPLOTPROFILE::DOACTION, IDLITOPPLOTPROFILE::GETPROPERTY
IDLITOPPLOTPROFILE::INIT, IDLITOPPLOTPROFILE::SETPROPERTY
IDLITOPPLOTPROFILE::_CLIPLINE, IDLITOPPLOTPROFILE::_CREATEPLOTPROFILE
IDLITOPPLOTPROFILE::_ENCODE, IDLitsys_CreateTool
[Previous]
[Next]
CLASS_NAME:
IDLitopPropertySheet
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopPropertySheet::Init
METHODS:
This class has the following methods:
IDLitopPropertySheet::Init
IDLitopPropertySheet::GetProperty
IDLitopPropertySheet::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPPROPERTYSHEET::DOACTION, IDLITOPPROPERTYSHEET::GETPROPERTY
IDLITOPPROPERTYSHEET::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopRedo
PURPOSE:
This file implements the redo operation for the IDL Tool system
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
CALLS: ***
IDLITOPREDO::DOACTION, IDLITOPREDO::QUERYAVAILABILITY
[Previous]
[Next]
CLASS_NAME:
IDLitopRenderVolume
PURPOSE:
Implements a high-quality render volume operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitOperation
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPRENDERVOLUME::DOACTION, IDLITOPRENDERVOLUME::INIT
[Previous]
[Next]
METHODNAME:
IDLitopRenderVolume::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitOpRenderVolume')
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITOPRENDERVOLUME::DOACTION, IDLITOPRENDERVOLUME::INIT
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitopRenderVolume::DoAction
PURPOSE:
Initialize this component
CALLING SEQUENCE:
self->DoAction
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITOPRENDERVOLUME::DOACTION, IDLITOPRENDERVOLUME::INIT
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
CLASS_NAME:
IDLitopResample
PURPOSE:
Implements the Resampling operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
INTERFACES:
IIDLProperty
CALLS: ***
CONGRID, IDLITOPRESAMPLE::DODATAOPERATION, IDLITOPRESAMPLE::DOEXECUTEUI
IDLITOPRESAMPLE::EXECUTE, IDLITOPRESAMPLE::GETPROPERTY
IDLITOPRESAMPLE::INIT, IDLITOPRESAMPLE::SETPROPERTY
IDLITOPRESAMPLE::_GETOPTARGETS
[Previous]
[Next]
CLASS_NAME:
IDLitopRotateAngle
PURPOSE:
This file implements the generic IDL Tool object that
implements the RotateAngle operation.
CALLS: ***
IDLITOPROTATEANGLE::CLEANUP, IDLITOPROTATEANGLE::DOACTION
IDLITOPROTATEANGLE::GETPROPERTY, IDLITOPROTATEANGLE::INIT
IDLITOPROTATEANGLE::SETPROPERTY, IDLITOPROTATEANGLE::_EXECUTEONROI
IDLITOPROTATEANGLE::_ROTATE, IDLITOPROTATEANGLE::_TARGETS, UNIQ
[Previous]
[Next]
CLASS_NAME:
IDLitopRotateByAngle
PURPOSE:
This file implements the generic IDL Tool object that
implements the RotateLeft operation.
CALLS: ***
IDLITOPROTATEBYANGLE::DOACTION, IDLITOPROTATEBYANGLE::GETPROPERTY
IDLITOPROTATEBYANGLE::INIT, IDLITOPROTATEBYANGLE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopRotateLeft
PURPOSE:
This file implements the generic IDL Tool object that
implements the RotateLeft operation.
CALLS: ***
IDLITOPROTATELEFT::DOACTION, IDLITOPROTATELEFT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopRotateRight
PURPOSE:
This file implements the generic IDL Tool object that
implements the RotateRight operation.
CALLS: ***
IDLITOPROTATERIGHT::DOACTION, IDLITOPROTATERIGHT::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopRunMacro
PURPOSE:
This file implements the run macro operation for the IDL Tool system
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
METHODS:
This class has the following methods:
IDLitopRunMacro::Init
IDLitopRunMacro::DoAction
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPRUNMACRO::DOACTION, IDLITOPRUNMACRO::GETPROPERTY
IDLITOPRUNMACRO::INIT, IDLITOPRUNMACRO::QUERYAVAILABILITY
IDLITOPRUNMACRO::RESTORE, IDLITOPRUNMACRO::SETPROPERTY
IDLITOPRUNMACRO::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitopScale
PURPOSE:
This file implements the operation that is used to set the scale
; factor on a visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopScale::Init
METHODS:
This class has the following methods:
IDLitopScale::Init
IDLitopScale::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPSCALE::GETINITIALXY, IDLITOPSCALE::INIT
IDLITOPSCALE::RECORDFINALVALUES, IDLITOPSCALE::RECORDINITIALVALUES
IDLITOPSCALE::REDOOPERATION, IDLITOPSCALE::SETFINALXY
IDLITOPSCALE::SETINITIALXY, IDLITOPSCALE::SETPROPERTY
IDLITOPSCALE::UNDOOPERATION, IDLITOPSCALE::_DOSCALE
[Previous]
[Next]
CLASS_NAME:
IDLitopScalefactor
PURPOSE:
This file implements the scalefactor action.
CALLS: ***
IDLITOPSCALEFACTOR::CLEANUP, IDLITOPSCALEFACTOR::DOEXECUTEUI
IDLITOPSCALEFACTOR::EXECUTE, IDLITOPSCALEFACTOR::GETPROPERTY
IDLITOPSCALEFACTOR::INIT, IDLITOPSCALEFACTOR::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopSelectAll
PURPOSE:
This file implements the operation that will select all visualizations
in the current windows current view.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopSelectAll::Init
METHODS:
This class has the following methods:
IDLitopSelectAll::Init
IDLitopSelectAll::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPSELECTALL::DOACTION, IDLITOPSELECTALL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopSelectionChange
PURPOSE:
This file implements the operation that will select all visualizations
in the current windows current view.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopSelectionChange::Init
METHODS:
This class has the following methods:
IDLitopSelectionChange::Init
IDLitopSelectionChange::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPSELECTIONCHANGE::DOACTION, IDLITOPSELECTIONCHANGE::GETPROPERTY
IDLITOPSELECTIONCHANGE::INIT
IDLITOPSELECTIONCHANGE::MANAGEPROPERTYSENSITIVITY
IDLITOPSELECTIONCHANGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopSetAsCurrentTool
PURPOSE:
This file implements the SetAsCurrentTool service. When exectued,
the tool this operation belongs to will be set as current in the
system.
This operation is primarly intended to be a service, allowing UI
to have the tool be set as current when a tool is placed in focus.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopSetAsCurrentTool
INTERFACES:
CALLS: ***
IDLITOPSETASCURRENTTOOL::DOACTION, IDLITOPSETASCURRENTTOOL::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopSetProperty
PURPOSE:
This file implements the operation that is used to set the value
of a property. This operation is needed so that property changes
can be recorded in the transaction system.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopSetProperty::Init
METHODS:
This class has the following methods:
IDLitopSetProperty::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPSETPROPERTY::DOACTION, IDLITOPSETPROPERTY::DOSETPROPERTYWITH_EXTRA
IDLITOPSETPROPERTY::INIT, IDLITOPSETPROPERTY::RECORDFINALVALUES
IDLITOPSETPROPERTY::RECORDINITIALVALUES, IDLITOPSETPROPERTY::REDOOPERATION
IDLITOPSETPROPERTY::UNDOOPERATION, IDLITOPSETPROPERTY::_DOSETPROPERTY
IDLITOPSETPROPERTY::_UNDOREDOOPERATION
[Previous]
[Next]
CLASS_NAME:
IDLitopSetXYZRange
PURPOSE:
This file implements the operation for setting the XYZ range
on a target.
CATEGORY:
IDL Tools
CALLS: ***
IDLITOPSETXYZRANGE::INIT, IDLITOPSETXYZRANGE::RECORDFINALVALUES
IDLITOPSETXYZRANGE::RECORDINITIALVALUES, IDLITOPSETXYZRANGE::REDOOPERATION
IDLITOPSETXYZRANGE::UNDOOPERATION, IDLITOPSETXYZRANGE::_UNDOREDO
[Previous]
[Next]
CLASS_NAME:
IDLitopShutdown
PURPOSE:
This file implements the tool shutdown operation. This is called
when it is desired to shutdown the tool in a graceful manner.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopShutdown
CALLS: ***
IDLITOPSHUTDOWN::DOACTION, IDLITOPSHUTDOWN::DOSHUTDOWN
IDLITOPSHUTDOWN::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitopSmooth
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
SUBCLASSES:
CREATION:
See IDLitopSmooth::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPSMOOTH::CLEANUP, IDLITOPSMOOTH::DOEXECUTEUI
IDLITOPSMOOTH::EXECUTE, IDLITOPSMOOTH::GETPROPERTY, IDLITOPSMOOTH::INIT
IDLITOPSMOOTH::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopStyleApply
PURPOSE:
This file implements the Style operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopStyleApply::Init
CALLS: ***
IDLITOPSTYLEAPPLY::DOACTION, IDLITOPSTYLEAPPLY::GETPROPERTY
IDLITOPSTYLEAPPLY::INIT, IDLITOPSTYLEAPPLY::SETPROPERTY
IDLITOPSTYLEAPPLY::_GETALLITEMS, IDLITOPSTYLEAPPLY::_GETSTYLEITEMS
IDLITOPSTYLEAPPLY::_GETSUBITEMS, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitopStyleCreate
PURPOSE:
This file implements the Style operation.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopStyleCreate::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITOPSTYLECREATE::DOACTION
IDLITOPSTYLECREATE::GETPROPERTY, IDLITOPSTYLECREATE::INIT
IDLITOPSTYLECREATE::SETPROPERTY, REVERSE, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitopStyleEditor
PURPOSE:
This file implements the IDL Tool object that
implements the actions performed when the Style Editor is opened.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopStyleEditor::Init
CALLS: ***
IDLITOPSTYLEEDITOR::DOACTION
[Previous]
[Next]
CLASS_NAME:
IDLitopToolChange
PURPOSE:
This file implements the operation that will select all visualizations
in the current windows current view.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopToolChange::Init
METHODS:
This class has the following methods:
IDLitopToolChange::Init
IDLitopToolChange::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPTOOLCHANGE::DOACTION, IDLITOPTOOLCHANGE::GETPROPERTY
IDLITOPTOOLCHANGE::INIT, IDLITOPTOOLCHANGE::MANAGEPROPERTYSENSITIVITY
IDLITOPTOOLCHANGE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitopUndo
PURPOSE:
This file implements the undo operation for the IDL Tool system
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
CALLS: ***
IDLITOPUNDO::DOACTION, IDLITOPUNDO::QUERYAVAILABILITY
[Previous]
[Next]
CLASS_NAME:
IDLitopUnknownData
PURPOSE:
This file implements the operation object that is used to grid data.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitopUnknownData::Init
METHODS:
This class has the following methods:
IDLitopUnknownData::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITOPUNKNOWNDATA::CLEANUP, IDLITOPUNKNOWNDATA::GETPROPERTY
IDLITOPUNKNOWNDATA::HANDLE, IDLITOPUNKNOWNDATA::INIT
IDLITOPUNKNOWNDATA::SETPROPERTY, IDLITOPUNKNOWNDATA::_HANDLE
[Previous]
[Next]
CLASS_NAME:
IDLitopUnsharpMask
PURPOSE:
This file implements the generic IDL Tool object that
implements the actions performed when a property sheet is used.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitDataOperation
SUBCLASSES:
CREATION:
See IDLitopUnsharpMask::Init
CALLS: ***
IDLITOPUNSHARPMASK::CLEANUP, IDLITOPUNSHARPMASK::DOEXECUTEUI
IDLITOPUNSHARPMASK::EXECUTE, IDLITOPUNSHARPMASK::GETPROPERTY
IDLITOPUNSHARPMASK::INIT, IDLITOPUNSHARPMASK::SETPROPERTY, UNSHARP_MASK
[Previous]
[Next]
CLASS_NAME:
IDLitopVectorContour
PURPOSE:
This file implements the operation that
creates contours from vector data.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitOperation
SUBCLASSES:
CREATION:
See IDLitopVectorContour::Init
CALLS: ***
IDLITOPVECTORCONTOUR::DOACTION, IDLITOPVECTORCONTOUR::INIT
IDLITOPVECTORCONTOUR::RESTORE, REVERSE
[Previous]
[Next]
CLASS_NAME:
IDLitopVectorStreamline
PURPOSE:
This file implements the operation that
creates streamline from vector data.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitOperation
SUBCLASSES:
CREATION:
See IDLitopVectorStreamline::Init
CALLS: ***
IDLITOPVECTORSTREAMLINE::DOACTION, IDLITOPVECTORSTREAMLINE::GETPROPERTY
IDLITOPVECTORSTREAMLINE::INIT, IDLITOPVECTORSTREAMLINE::RESTORE
IDLITOPVECTORSTREAMLINE::SETPROPERTY
IDLITOPVECTORSTREAMLINE::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitParameter
PURPOSE:
This class implements a parameter interface that allows names to
be associated with data objects. As part of this functionality,
parameter-data type matchings functionality is provided as well as
the ability to recieve updates when data values have changed.
It is expected that this class is included in other classes that
require a parameter interface.
SUPERCLASSES:
None
CALLS: ***
IDLITLANGCATQUERY, IDLITPARAMETER::ADDAUXILIARYDATA, IDLITPARAMETER::CLEANUP
IDLITPARAMETER::GETAUXILIARYDATA, IDLITPARAMETER::GETOPTARGETS
IDLITPARAMETER::GETPARAMETER, IDLITPARAMETER::GETPARAMETERATTRIBUTE
IDLITPARAMETER::GETPARAMETERDATABYTYPE, IDLITPARAMETER::GETPARAMETERNAME
IDLITPARAMETER::GETPARAMETERSET, IDLITPARAMETER::GETPARAMETERTYPES
IDLITPARAMETER::INIT, IDLITPARAMETER::ONDATACHANGE
IDLITPARAMETER::ONDATACHANGEUPDATE, IDLITPARAMETER::ONDATACOMPLETE
IDLITPARAMETER::ONDATADELETE, IDLITPARAMETER::ONDATADISCONNECT
IDLITPARAMETER::QUERYPARAMETER, IDLITPARAMETER::QUERYPARAMETERDESCRIPTOR
IDLITPARAMETER::REGISTERPARAMETER, IDLITPARAMETER::SETDATA
IDLITPARAMETER::SETPARAMETER, IDLITPARAMETER::SETPARAMETERATTRIBUTE
IDLITPARAMETER::SETPARAMETERSET, IDLITPARAMETER::UNSETPARAMETER
IDLITPARAMETER::_DISCONNECTPARAMETERS, UNIQ
[Previous]
[Next]
CLASS_NAME:
IDLitParameterSet
PURPOSE:
This file implements the IDLitParameterSet class. This class provides
a data container that is aware of data objects stored in it. It uses
data identifiers to locate data objects stored in a data container
tree heirarchy.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDlitDataContainer
See IDLitParameterSet::Init
CALLS: ***
IDLITLANGCATQUERY, IDLITPARAMETERSET::ADD
IDLITPARAMETERSET::ADDAUXILIARYDATA, IDLITPARAMETERSET::CLEANUP
IDLITPARAMETERSET::COPY, IDLITPARAMETERSET::GET
IDLITPARAMETERSET::GETAUXILIARYDATA, IDLITPARAMETERSET::GETBYNAME
IDLITPARAMETERSET::GETPARAMETERNAME, IDLITPARAMETERSET::INIT
IDLITPARAMETERSET::REMOVE, IDLITPARAMETERSET::_COPYDATANAMES
[Previous]
[Next]
CLASS_NAME:
IDLitPrompt
PURPOSE:
Generic user prompt object. Used to send messages to the UI
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitPrompt::Init
METHODS:
This class has the following methods:
IDLitPrompt::Init
IDLitPrompt::Cleanup
IDLitPrompt::GetProperty
IDLitPrompt::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITPROMPT::CLEANUP, IDLITPROMPT::GETPROPERTY, IDLITPROMPT::INIT
IDLITPROMPT::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitPromptText
PURPOSE:
Generic user prompt object. Used to send messages to the UI
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitPromptText::Init
METHODS:
This class has the following methods:
IDLitPromptText::Init
IDLitPromptText::Cleanup
IDLitPromptText::GetProperty
IDLitPromptText::SetProperty
INTERFACES:
IIDLProperty
CALLS: ***
IDLITPROMPTTEXT::CLEANUP, IDLITPROMPTTEXT::GETPROPERTY
IDLITPROMPTTEXT::INIT, IDLITPROMPTTEXT::SETPROPERTY
[Previous]
[Next]
IDLitPropertyAggregate__Define
PURPOSE:
Defines the object structure for an IDLitPropertyAggregate object.
CALLS: ***
IDLITPROPERTYAGGREGATE::CLEANUP, IDLITPROPERTYAGGREGATE::GETPROPERTY
IDLITPROPERTYAGGREGATE::INIT, IDLITPROPERTYAGGREGATE::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitPropertyBag
PURPOSE:
This file implements the IDLitPropertyBag class. This class is
used to publish and manage a set of properties exposed by a give
object.
This object is used in the given way:
- Create the object.
- Provide an object for it to "mimic" or record
properties for.
* This object will publish those properties.
* This object will cache those properties values.
- At this point, this object can "proxy" the properities
that were recorded.
- Later in time, the property values can be reset to another
object
CATEGORY:
IDL Tools
SUPERCLASSES:
None
CREATION:
See IDLitPropertyBag::Init
CALLS: ***
IDLITPROPERTYBAG::CLEANUP, IDLITPROPERTYBAG::GETPROPERTY
IDLITPROPERTYBAG::INIT, IDLITPROPERTYBAG::PLAYBACKPROPERTIES
IDLITPROPERTYBAG::RECORDPROPERTIES, IDLITPROPERTYBAG::RECORDPROPERTY
IDLITPROPERTYBAG::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitReader
PURPOSE:
This file implements the IDLitReader class. This class is an abstract
class for other file readers.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
IDLitIMessaging
_IDLitFileIOAttrs
SUBCLASSES:
CREATION:
See IDLitReader::Init
CALLS: ***
IDLITREADER::CLEANUP, IDLITREADER::GETDATA, IDLITREADER::INIT
IDLITREADER::ISA
[Previous]
[Next]
CLASS_NAME:
IDLitRegClass
PURPOSE:
This file implements the IDLitRegClass class. This class provides
a method to register class based item information.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitObjDescTool
SUBCLASSES:
CREATION:
See IDLitRegClass::Init
METHODS:
This class has the following methods:
IDLitRegClass::Init
IDLitRegClass::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITREGCLASS::GETPROPERTY, IDLITREGCLASS::INIT
[Previous]
[Next]
PROXY_NAME:
IDLitRegProxy
PURPOSE:
This file implements the IDLitRegProxy class. This class provides
a method to register proxy-based item information.
CALLS: ***
IDLITREGPROXY::GETPROPERTY, IDLITREGPROXY::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitRegRoutine
PURPOSE:
This file implements the IDLitRegRoutine class. This class provides
a method to register simple routines in a object registry.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitRegRoutine::Init
METHODS:
This class has the following methods:
IDLitRegRoutine::Init
IDLitRegRoutine::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITREGROUTINE::CLEANUP, IDLITREGROUTINE::GETPROPERTY
IDLITREGROUTINE::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitRegTarget
PURPOSE:
This file implements the IDLitRegTarget class. This class provides
a method to register target-based item information.
CALLS: ***
IDLITREGTARGET::GETPROPERTY, IDLITREGTARGET::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitSelectContainer
PURPOSE:
Used to manage the containment and state of a visualization
tree selection state.
CATEGORY:
Components
SUPERCLASSES:
None.
SUBCLASSES:
CREATION:
See ::Init
METHODS:
ClearSelections
AddSelectedItem
RemoveSelectedItem
SetSelectedItem
GetSelectedItems
CALLS: ***
IDLITSELECTCONTAINER::ADDSELECTEDITEM, IDLITSELECTCONTAINER::CLEANUP
IDLITSELECTCONTAINER::CLEARSELECTIONS
IDLITSELECTCONTAINER::GETSELECTEDITEMS, IDLITSELECTCONTAINER::INIT
IDLITSELECTCONTAINER::REMOVESELECTEDITEM
IDLITSELECTCONTAINER::SETPRIMARYSELECTEDITEM
IDLITSELECTCONTAINER::SETSELECTEDITEM
IDLITSELECTCONTAINER::_NOTIFYSELECTIONCHANGE
[Previous]
[Next]
CLASS_NAME:
IDLitSelectParent
PURPOSE:
Defines/Implements the default selection parent methods. These
just pass information up to it's parent.
ASSUMPTIONS:
The class that implements this provides a PARENT property and
the parent impelements this interface.
This is not intended to be a stand-alone class.
CATEGORY:
Components
SUPERCLASSES:
None.
SUBCLASSES:
CREATION:
METHODS:
AddSelecedItem
RemoveSelectedItem
SetSelectedItem
CALLS: ***
IDLITSELECTPARENT::ADDSELECTEDITEM, IDLITSELECTPARENT::REMOVESELECTEDITEM
IDLITSELECTPARENT::SETPRIMARYSELECTEDITEM
IDLITSELECTPARENT::SETSELECTEDITEM
[Previous]
[Next]
IDLitSelectContainer::AddSelectedItem
PURPOSE:
This method passes up an add selected item to it's parent.
INPUTS:
oItem - The item to select
CALLS: ***
IDLITSELECTPARENT::ADDSELECTEDITEM, IDLITSELECTPARENT::REMOVESELECTEDITEM
IDLITSELECTPARENT::SETPRIMARYSELECTEDITEM
IDLITSELECTPARENT::SETSELECTEDITEM
[Previous]
[Next]
IDLitSelectParent::SetSelectedItem
PURPOSE:
This routine passes up the set selected item call up the
tree.
INPUTS:
oItem - The item to select
CALLS: ***
IDLITSELECTPARENT::ADDSELECTEDITEM, IDLITSELECTPARENT::REMOVESELECTEDITEM
IDLITSELECTPARENT::SETPRIMARYSELECTEDITEM
IDLITSELECTPARENT::SETSELECTEDITEM
[Previous]
[Next]
IDLitSelectParent::RemoveSelectedItem
PURPOSE:
Used to pass the call to Remove a selected item up the tree.
INPUTS:
oItem - The item to remove
CALLS: ***
IDLITSELECTPARENT::ADDSELECTEDITEM, IDLITSELECTPARENT::REMOVESELECTEDITEM
IDLITSELECTPARENT::SETPRIMARYSELECTEDITEM
IDLITSELECTPARENT::SETSELECTEDITEM
[Previous]
[Next]
IDLitSelectParent::Define
Purpose:
Define the selection container.
CALLS: ***
IDLITSELECTPARENT::ADDSELECTEDITEM, IDLITSELECTPARENT::REMOVESELECTEDITEM
IDLITSELECTPARENT::SETPRIMARYSELECTEDITEM
IDLITSELECTPARENT::SETSELECTEDITEM
[Previous]
[Next]
CLASS_NAME:
IDLitsrvCreateDataSpace
PURPOSE:
This file implements the operation object that is used to create
a visualization.
CALLS: ***
IDLITLANGCATQUERY, IDLITSRVCREATEDATASPACE::CREATEDATASPACE
IDLITSRVCREATEDATASPACE::INIT, IDLITSRVCREATEDATASPACE::REDOOPERATION
IDLITSRVCREATEDATASPACE::UNDOOPERATION
IDLITSRVCREATEDATASPACE::_APPLYPROPERTIES
IDLITSRVCREATEDATASPACE::_CREATE
IDLITSRVCREATEDATASPACE::_GETANDCHECKOBJECTS
[Previous]
[Next]
CLASS_NAME:
IDLitsrvCreateVisualization
PURPOSE:
This file implements the operation object that is used to create
a visualization.
CATEGORY:
IDL Tools
SUPERCLASSES:
SUBCLASSES:
CREATION:
See IDLitsrvCreateVisualization::Init
METHODS:
This class has the following methods:
IDLitsrvCreateVisualization::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY
IDLITSRVCREATEVISUALIZATION::CREATEVISUALIZATION
IDLITSRVCREATEVISUALIZATION::INIT
IDLITSRVCREATEVISUALIZATION::PROGRESSBAR
IDLITSRVCREATEVISUALIZATION::REDOOPERATION
IDLITSRVCREATEVISUALIZATION::UNDOOPERATION
IDLITSRVCREATEVISUALIZATION::_CHECKVISDATASUPPORT
IDLITSRVCREATEVISUALIZATION::_CREATE
IDLITSRVCREATEVISUALIZATION::_FINDVISUALIZATIONBYDATATYPE
IDLITSRVCREATEVISUALIZATION::_GETANDCHECKOBJECTS
IDLITSRVCREATEVISUALIZATION::_HANDLEDATANOMATCH, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitsrvLangCat
PURPOSE:
This file implements the IDL Tool services needed for using
the language catalogs
CATEGORY:
Internationalization
SUPERCLASSES:
IDLitOperation
SUBCLASSES:
This class has no subclasses.
CREATION:
Created by the Tool system routines.
METHODS:
IDLitsrvLangCat::Query
IDLitsrvLangCat::SetLanguage
IDLitsrvLangCat::GetAvailableLanguages
CALLS: ***
IDLITSRVLANGCAT::CLEANUP, IDLITSRVLANGCAT::GETAVAILABLELANGUAGES
IDLITSRVLANGCAT::GETLANGUAGE, IDLITSRVLANGCAT::GETPROPERTY
IDLITSRVLANGCAT::INIT, IDLITSRVLANGCAT::QUERY, IDLITSRVLANGCAT::SETLANGUAGE
IDLITSRVLANGCAT::_GETDEFAULTLANGUAGE
MODIFICATION HISTORY:
Created by: AGEH, December 2003
[Previous]
[Next]
CLASS_NAME:
IDLitStyleFolder
PURPOSE:
This file implements the IDLitStyleFolder class.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitContainer
SUBCLASSES:
CREATION:
See IDLitStyleFolder::Init
CALLS: ***
IDLITSTYLEFOLDER::INIT, IDLITSTYLEFOLDER::SETPROPERTY
IDLITSTYLEFOLDER::_VERIFYNAME, STRSPLIT, _IDLitsys_GetSystem
[Previous]
[Next]
CLASS_NAME:
IDLitSymbol
PURPOSE:
The IDLitSymbol class is the component wrapper for IDLgrSymbol.
CATEGORY:
Components
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CALLS: ***
IDLITSYMBOL::CLEANUP, IDLITSYMBOL::GETPROPERTY, IDLITSYMBOL::GETSYMBOL
IDLITSYMBOL::INIT, IDLITSYMBOL::RESTORE, IDLITSYMBOL::SETPROPERTY
IDLITSYMBOL::_REGISTERPROPERTIES
MODIFICATION HISTORY:
Written by: Chris, August 2002
[Previous]
[Next]
METHODNAME:
IDLitSymbol::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitSymbol')
INPUTS:
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrSymbol
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITSYMBOL::CLEANUP, IDLITSYMBOL::GETPROPERTY, IDLITSYMBOL::GETSYMBOL
IDLITSYMBOL::INIT, IDLITSYMBOL::RESTORE, IDLITSYMBOL::SETPROPERTY
IDLITSYMBOL::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitSymbol::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitSymbol::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitSymbol::Init followed by the word "Get"
can be retrieved using IDLitSymbol::GetProperty.
CALLS: ***
IDLITSYMBOL::CLEANUP, IDLITSYMBOL::GETPROPERTY, IDLITSYMBOL::GETSYMBOL
IDLITSYMBOL::INIT, IDLITSYMBOL::RESTORE, IDLITSYMBOL::SETPROPERTY
IDLITSYMBOL::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitSymbol::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitSymbol::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitSymbol::Init followed by the word "Set"
can be set using IDLitSymbol::SetProperty.
CALLS: ***
IDLITSYMBOL::CLEANUP, IDLITSYMBOL::GETPROPERTY, IDLITSYMBOL::GETSYMBOL
IDLITSYMBOL::INIT, IDLITSYMBOL::RESTORE, IDLITSYMBOL::SETPROPERTY
IDLITSYMBOL::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitSymbol__Define
PURPOSE:
Defines the object structure for an IDLitSymbol object.
CALLS: ***
IDLITSYMBOL::CLEANUP, IDLITSYMBOL::GETPROPERTY, IDLITSYMBOL::GETSYMBOL
IDLITSYMBOL::INIT, IDLITSYMBOL::RESTORE, IDLITSYMBOL::SETPROPERTY
IDLITSYMBOL::_REGISTERPROPERTIES
[Previous]
[Next]
NAME:
IDLitsys_CreateTool
PURPOSE:
Provides a procedurual interface to create IDL tools. This is
primarly used for the procedureal interface exposed by the itools
system. This routine will also verify that the system is up and running.
This is an internal routine.
CALLING SEQUENCE:
id = IDLitSys_CreateTool(strTool)
PARAMETERS
strTool - The name of the tool to create
KEYWORDS
All keywords are passsed to the system objects CreateTool method.
DISABLE_UPDATES: Set this keyword to disable updates on the
newly-created tool. If this keyword is set then the user
is responsible for calling EnableUpdates on the tool.
This keyword is useful when you want to do a subsequent overplot
or use DoAction to call an operation, but do not want to see the
intermediate steps.
Note: This keyword is ignored if the tool already exists.
In this case you should call DisableUpdates on the tool
before calling IDLitSys_CreateTool.
RETURN VALUE
This routine will return the identifier of the created tool. If no
tool was created, then an empty '' string is returned.
CALLS: ***
IDLITSYS_CREATETOOL__EMPTYVIEW, _IDLitsys_GetSystem
CALLED BY:
IPLOT, iContour, iImage, iMap [2], iSurface, iVolume, idlitophistogram__define
idlitopimageplaneiimage__define, idlitopplotprofile__define
[Previous]
[Next]
CLASS_NAME:
IDLitSystem
PURPOSE:
This file implements the overall tool system/enviroment that
is used to manage items that are outside the tool scope.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitSystem::Init
METHODS:
INTERFACES:
IIDLProperty
CALLS: ***
FILEPATH, IDLITGETRESOURCE, IDLITLANGCATQUERY
IDLITSYSTEM::ADDONNOTIFYOBSERVER, IDLITSYSTEM::ADDSERVICE
IDLITSYSTEM::ADDSETTING, IDLITSYSTEM::BEGINCLIPBOARDINTERACTION
IDLITSYSTEM::CLEANUP, IDLITSYSTEM::CLEARCLIPBOARD, IDLITSYSTEM::CREATETOOL
IDLITSYSTEM::CREATEVISUALIZATION, IDLITSYSTEM::DELETETOOL
IDLITSYSTEM::DISABLEPROGRESSBAR, IDLITSYSTEM::DOONNOTIFY
IDLITSYSTEM::DOSETPROPERTY, IDLITSYSTEM::DOUISERVICE
IDLITSYSTEM::ENABLEPROGRESSBAR, IDLITSYSTEM::ENDCLIPBOARDINTERACTION
IDLITSYSTEM::GETANNOTATION, IDLITSYSTEM::GETCLIPBOARDITEMCOUNT
IDLITSYSTEM::GETCURRENTTOOL, IDLITSYSTEM::GETFILEREADER
IDLITSYSTEM::GETFILEWRITER, IDLITSYSTEM::GETLASTERRORINFO
IDLITSYSTEM::GETPROPERTY, IDLITSYSTEM::GETSERVICE, IDLITSYSTEM::GETSETTING
IDLITSYSTEM::GETVISUALIZATION, IDLITSYSTEM::INIT, IDLITSYSTEM::LANGCATQUERY
IDLITSYSTEM::PROGRESSBAR, IDLITSYSTEM::REGISTERANNOTATION
IDLITSYSTEM::REGISTERFILEREADER, IDLITSYSTEM::REGISTERFILEWRITER
IDLITSYSTEM::REGISTEROPERATION, IDLITSYSTEM::REGISTERTOOL
IDLITSYSTEM::REGISTERTOOLMANIPULATOR, IDLITSYSTEM::REGISTERTOOLOPERATION
IDLITSYSTEM::REGISTERUIPANEL, IDLITSYSTEM::REGISTERUISERVICE
IDLITSYSTEM::REGISTERUSERINTERFACE, IDLITSYSTEM::REGISTERVISUALIZATION
IDLITSYSTEM::REMOVEONNOTIFYOBSERVER, IDLITSYSTEM::SENDMESSAGETOUI
IDLITSYSTEM::SETCURRENTTOOL, IDLITSYSTEM::UNREGISTERANNOTATION
IDLITSYSTEM::UNREGISTERFILEREADER, IDLITSYSTEM::UNREGISTERFILEWRITER
IDLITSYSTEM::UNREGISTERVISUALIZATION, IDLITSYSTEM::UPDATETOOLBYTYPE
IDLITSYSTEM::VERIFYCONTAINER, IDLITSYSTEM::VERIFYDESCRIPTOR
IDLITSYSTEM::_ADDSERVICES, IDLITSYSTEM::_GETALLSUPERCLASSES
IDLITSYSTEM::_GETCURRENTTOOL, IDLITSYSTEM::_GETNEXTTOOLLOCATION
IDLITSYSTEM::_GETSYSTEM, IDLITSYSTEM::_GETTOOLMANIPULATORSBYTYPE
IDLITSYSTEM::_GETTOOLOPERATIONSBYTYPE, IDLITSYSTEM::_GETUIPANELROUTINES
IDLITSYSTEM::_INITIALIZEUSERINTERFACE, IDLITSYSTEM::_INITREGISTRY
IDLITSYSTEM::_INITTOOLLAYOUT, IDLITSYSTEM::_REGISTERDEFAULTITEMS
IDLITSYSTEM::_REGISTEROPERATIONS, IDLITSYSTEM::_REGISTERPREFERENCES
IDLITSYSTEM::_REGISTERREADERWRITER, IDLITSYSTEM::_REGISTERREADERWRITERS
IDLITSYSTEM::_REGISTERTOOLS, IDLITSYSTEM::_REGISTERUICONNECTION
IDLITSYSTEM::_REGISTERUIPANELS, IDLITSYSTEM::_REGISTERUISERVICES
IDLITSYSTEM::_REGISTERVISUALIZATIONS, IDLITSYSTEM::_REMOVETOOL
IDLITSYSTEM::_RESETSETTINGS, IDLITSYSTEM::_RESTORESETTINGS
IDLITSYSTEM::_SAVESETTINGS, IDLITSYSTEM::_SETCURRENTTOOL
IDLITSYSTEM::_SETERROR, IDLITSYSTEM::_UNREGISTERUICONNECTION
IDLITSYSTEM::_UPDATECLIPBOARDSTATUS, IDLITSYSTEM::__RESETSYSTEM
IDLitUISystem, UNIQ, get_screen_size
[Previous]
[Next]
CLASS_NAME:
IDLitTool
PURPOSE:
This file implements the generic IDL Tool object that
defines all interfaces and encapsulates the functionaltiy of
an IDL tool. This generic tool is used to implement all IDL
tools.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitContainer
IDLitIMessaging
_IDLitObjDescRegistry
CREATION:
See IDLitTool::Init
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITTOOL::ACTIVATEMANIPULATOR
IDLITTOOL::ADD, IDLITTOOL::ADDONNOTIFYOBSERVER, IDLITTOOL::ADDSERVICE
IDLITTOOL::CLEANUP, IDLITTOOL::COMMITACTIONS, IDLITTOOL::CREATE
IDLITTOOL::CUSTOMIZEGRAPHICS, IDLITTOOL::DISABLEPROGRESSBAR
IDLITTOOL::DISABLEUPDATES, IDLITTOOL::DOACTION, IDLITTOOL::DOONNOTIFY
IDLITTOOL::DOSETPROPERTY, IDLITTOOL::DOUISERVICE
IDLITTOOL::ENABLEPROGRESSBAR, IDLITTOOL::ENABLEUPDATES
IDLITTOOL::FINDIDENTIFIERS, IDLITTOOL::GETANNOTATION
IDLITTOOL::GETCURRENTMANIPULATOR, IDLITTOOL::GETCURRENTWINDOW
IDLITTOOL::GETFILEREADER, IDLITTOOL::GETFILEWRITER
IDLITTOOL::GETLASTERRORINFO, IDLITTOOL::GETMANIPULATORS
IDLITTOOL::GETOPERATIONS, IDLITTOOL::GETPROPERTY
IDLITTOOL::GETSELECTEDITEMS, IDLITTOOL::GETSERVICE
IDLITTOOL::GETSTATUSBARSEGMENTS, IDLITTOOL::GETSTATUSMESSAGEID
IDLITTOOL::GETVISUALIZATION, IDLITTOOL::HASVISUALIZATIONS, IDLITTOOL::INIT
IDLITTOOL::ONMANIPULATORCHANGE, IDLITTOOL::ONSELECTIONCHANGE
IDLITTOOL::PROGRESSBAR, IDLITTOOL::REFRESHCURRENTWINDOW, IDLITTOOL::REGISTER
IDLITTOOL::REGISTERANNOTATION, IDLITTOOL::REGISTERCUSTOMIZATION
IDLITTOOL::REGISTERFILEREADER, IDLITTOOL::REGISTERFILEWRITER
IDLITTOOL::REGISTERMANIPULATOR, IDLITTOOL::REGISTEROPERATION
IDLITTOOL::REGISTERSTATUSBARSEGMENT, IDLITTOOL::REGISTERVISUALIZATION
IDLITTOOL::REMOVEONNOTIFYOBSERVER, IDLITTOOL::SENDMESSAGETOUI
IDLITTOOL::SETPROPERTY, IDLITTOOL::UNREGISTERANNOTATION
IDLITTOOL::UNREGISTERCUSTOMIZATION, IDLITTOOL::UNREGISTERFILEREADER
IDLITTOOL::UNREGISTERFILEWRITER, IDLITTOOL::UNREGISTERMANIPULATOR
IDLITTOOL::UNREGISTEROPERATION, IDLITTOOL::UNREGISTERSTATUSBARSEGMENT
IDLITTOOL::UNREGISTERVISUALIZATION, IDLITTOOL::_ADDCOMMAND
IDLITTOOL::_CHECKFORUNSAVED, IDLITTOOL::_CLEARLASTERROR
IDLITTOOL::_DOREDOCOMMAND, IDLITTOOL::_DOUNDOCOMMAND
IDLITTOOL::_GETCOMMANDBUFFER, IDLITTOOL::_GETREADERWRITER
IDLITTOOL::_GETSYSTEM, IDLITTOOL::_GETVISUALIZATION
IDLITTOOL::_INITIALIZESERVICES, IDLITTOOL::_PERFORMDISPLAYUPDATES
IDLITTOOL::_REGISTERUICONNECTION, IDLITTOOL::_REMOVECOMMAND
IDLITTOOL::_SETCURRENTWINDOW, IDLITTOOL::_SETDIRTY, IDLITTOOL::_SETERROR
IDLITTOOL::_SETSCENE, IDLITTOOL::_SETSYSTEM, IDLITTOOL::_TRANSACTCOMMAND
IDLITTOOL::_UNREGISTERUICONNECTION, IDLITTOOL::_UPDATECLIPBOARDSTATUS
IDLITTOOL::_UPDATETOOLBYTYPE, STRSPLIT, UNIQ, _IDLitsys_GetSystem
[Previous]
[Next]
METHODNAME:
IDLitTool::Create
PURPOSE:
This function method initializes any heavyweight portions of this
visualization. [Note: the bare essentials for the object are initialized
within the ::Init method.]
CALLING SEQUENCE:
status = Obj->[IDLitTool::]Create()
OUTPUTS:
This function returns a 1 on success, or 0 on failure.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITTOOL::ACTIVATEMANIPULATOR
IDLITTOOL::ADD, IDLITTOOL::ADDONNOTIFYOBSERVER, IDLITTOOL::ADDSERVICE
IDLITTOOL::CLEANUP, IDLITTOOL::COMMITACTIONS, IDLITTOOL::CREATE
IDLITTOOL::CUSTOMIZEGRAPHICS, IDLITTOOL::DISABLEPROGRESSBAR
IDLITTOOL::DISABLEUPDATES, IDLITTOOL::DOACTION, IDLITTOOL::DOONNOTIFY
IDLITTOOL::DOSETPROPERTY, IDLITTOOL::DOUISERVICE
IDLITTOOL::ENABLEPROGRESSBAR, IDLITTOOL::ENABLEUPDATES
IDLITTOOL::FINDIDENTIFIERS, IDLITTOOL::GETANNOTATION
IDLITTOOL::GETCURRENTMANIPULATOR, IDLITTOOL::GETCURRENTWINDOW
IDLITTOOL::GETFILEREADER, IDLITTOOL::GETFILEWRITER
IDLITTOOL::GETLASTERRORINFO, IDLITTOOL::GETMANIPULATORS
IDLITTOOL::GETOPERATIONS, IDLITTOOL::GETPROPERTY
IDLITTOOL::GETSELECTEDITEMS, IDLITTOOL::GETSERVICE
IDLITTOOL::GETSTATUSBARSEGMENTS, IDLITTOOL::GETSTATUSMESSAGEID
IDLITTOOL::GETVISUALIZATION, IDLITTOOL::HASVISUALIZATIONS, IDLITTOOL::INIT
IDLITTOOL::ONMANIPULATORCHANGE, IDLITTOOL::ONSELECTIONCHANGE
IDLITTOOL::PROGRESSBAR, IDLITTOOL::REFRESHCURRENTWINDOW, IDLITTOOL::REGISTER
IDLITTOOL::REGISTERANNOTATION, IDLITTOOL::REGISTERCUSTOMIZATION
IDLITTOOL::REGISTERFILEREADER, IDLITTOOL::REGISTERFILEWRITER
IDLITTOOL::REGISTERMANIPULATOR, IDLITTOOL::REGISTEROPERATION
IDLITTOOL::REGISTERSTATUSBARSEGMENT, IDLITTOOL::REGISTERVISUALIZATION
IDLITTOOL::REMOVEONNOTIFYOBSERVER, IDLITTOOL::SENDMESSAGETOUI
IDLITTOOL::SETPROPERTY, IDLITTOOL::UNREGISTERANNOTATION
IDLITTOOL::UNREGISTERCUSTOMIZATION, IDLITTOOL::UNREGISTERFILEREADER
IDLITTOOL::UNREGISTERFILEWRITER, IDLITTOOL::UNREGISTERMANIPULATOR
IDLITTOOL::UNREGISTEROPERATION, IDLITTOOL::UNREGISTERSTATUSBARSEGMENT
IDLITTOOL::UNREGISTERVISUALIZATION, IDLITTOOL::_ADDCOMMAND
IDLITTOOL::_CHECKFORUNSAVED, IDLITTOOL::_CLEARLASTERROR
IDLITTOOL::_DOREDOCOMMAND, IDLITTOOL::_DOUNDOCOMMAND
IDLITTOOL::_GETCOMMANDBUFFER, IDLITTOOL::_GETREADERWRITER
IDLITTOOL::_GETSYSTEM, IDLITTOOL::_GETVISUALIZATION
IDLITTOOL::_INITIALIZESERVICES, IDLITTOOL::_PERFORMDISPLAYUPDATES
IDLITTOOL::_REGISTERUICONNECTION, IDLITTOOL::_REMOVECOMMAND
IDLITTOOL::_SETCURRENTWINDOW, IDLITTOOL::_SETDIRTY, IDLITTOOL::_SETERROR
IDLITTOOL::_SETSCENE, IDLITTOOL::_SETSYSTEM, IDLITTOOL::_TRANSACTCOMMAND
IDLITTOOL::_UNREGISTERUICONNECTION, IDLITTOOL::_UPDATECLIPBOARDSTATUS
IDLITTOOL::_UPDATETOOLBYTYPE, STRSPLIT, UNIQ, _IDLitsys_GetSystem
[Previous]
[Next]
NAME:
IDLittool_systeminit
PURPOSE:
Load system related files
CALLING SEQUENCE:
CALLS: ***
FILEPATH, IDLITWDSPLASH
MODIFICATION HISTORY:
[Previous]
[Next]
CLASS_NAME:
IDLitToolbase
PURPOSE:
This file implements the IDL Tool base object, from which all other
Tools are subclassed.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitTool
SUBCLASSES:
CREATION:
See IDLitToolbase::Init
METHODS:
This class has the following methods:
IDLitToolbase::Init
INTERFACES:
IIDLProperty
CALLS: ***
IDLITLANGCATQUERY, IDLITTOOLBASE::INIT
[Previous]
[Next]
CLASS_NAME:
IDLitUI
PURPOSE:
This file implements the generic IDL Tool User Interface object
manages the connection between the underlying tool object and
the elements that comprise the user interface.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitUI::Init
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITUI::ADDONNOTIFYOBSERVER
IDLITUI::CLEANUP, IDLITUI::DOACTION, IDLITUI::DOUISERVICE
IDLITUI::GETPROPERTY, IDLITUI::GETTOOL, IDLITUI::GETWIDGETBYNAME
IDLITUI::HANDLEMESSAGE, IDLITUI::HANDLEONNOTIFY, IDLITUI::INIT
IDLITUI::ONNOTIFY, IDLITUI::REGISTERMENUBAR, IDLITUI::REGISTERTOOLBAR
IDLITUI::REGISTERUISERVICE, IDLITUI::REGISTERWIDGET
IDLITUI::REMOVEONNOTIFYOBSERVER, IDLITUI::SETPROPERTY
IDLITUI::UNREGISTERMENUBAR, IDLITUI::UNREGISTERTOOLBAR
IDLITUI::UNREGISTERUISERVICE, IDLITUI::UNREGISTERWIDGET
IDLITUI::_CLEANUPWIDGETS, IDLITUI::_REGISTERITEM, IDLITUI::_UNREGISTERITEM
[Previous]
[Next]
CLASS_NAME:
IDLitUIAdaptor
PURPOSE:
This file implements the IDLitUIAdaptor class. This class provides
an object adaptor that allows object methodology to be dispatch to
IDL widget elements that comprise the user interface.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitUIAdaptor::Init
METHODS:
This class has the following methods:
IDLitUIAdaptor::Init
IDLitUIAdaptor::Cleanup
INTERFACES:
IIDLProperty
CALLS: ***
IDLITUIADAPTOR::CLEANUP, IDLITUIADAPTOR::DOUISERVICE
IDLITUIADAPTOR::GETPROPERTY, IDLITUIADAPTOR::INIT, IDLITUIADAPTOR::ONNOTIFY
IDLITUIADAPTOR::SETPROPERTY
[Previous]
[Next]
NAME:
IDLitUIAsciiTemplate
PURPOSE:
This function implements the user interface for ASCII_TEMPLATE.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIAsciiTemplate(oUI, oRequester)
INPUTS:
oUI - Set this argument to the object reference for the UI.
oRequester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
ASCII_TEMPLATE
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIBinaryTemplate
PURPOSE:
This function implements the user interface for BINARY_TEMPLATE.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIBinaryTemplate(oUI, oRequester)
INPUTS:
oUI - Set this argument to the object reference for the UI.
oRequester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
BINARY_TEMPLATE
MODIFICATION HISTORY:
Written by: CT, RSI, Feb 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIBrowser
PURPOSE:
This function implements the user interface for a simple Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIBrowser(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdBrowser
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIBrowserVis
PURPOSE:
This function implements the user interface for the Vis Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIBrowserVis(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdBrowser
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLituiBuffer
PURPOSE:
Create the IDL UI (widget) interface for an associated tool object.
CALLING SEQUENCE:
IDLituiBuffer, Tool
INPUTS:
Tool - Object reference to the tool object.
CALLS: ***
IDLITLANGCATQUERY
[Previous]
[Next]
CLASS_NAME:
IDLitUIConsole
PURPOSE:
This file implements a simple command line messaging interface
that can be called with standard message objects and will print
output to the command log.
This is mostly used with the system object, allowing messaging
interaction with the IDL command line and not relying on widgets.
CATEGORY:
IDL Tools
SUPERCLASSES:
IDLitComponent
SUBCLASSES:
CREATION:
See IDLitUIConsole::Init
CALLS: ***
IDLITUICONSOLE::HANDLEMESSAGE, IDLITUICONSOLE::INIT
IDLITUICONSOLE::_ERRORMESSAGE, IDLITUICONSOLE::_PROMPTTEXT
IDLITUICONSOLE::_PROMPTYESNO
[Previous]
[Next]
NAME:
IDLitUIContourLevels
PURPOSE:
This function implements the user interface for the ContourLevels
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIContourLevels(oUI, Requester)
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLitwdPropertySheet, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLituiControlMacro
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiControlMacro(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITWDCONTROLMACRO
MODIFICATION HISTORY:
Written by: AY, RSI, Dec 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIConvolKernel
PURPOSE:
This function implements the user interface for the Operation Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIConvolKernel(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdConvolKernel, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIConvolKernel
PURPOSE:
This function implements the user interface for the Operation Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIConvolKernel(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITUIMAPREGISTERIMAGE, IDLitwdMapRegisterImage
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUICurveFitting
PURPOSE:
This function implements the user interface for curve fitting
for the IDL iTool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUICurveFitting(oUI, Requester)
INPUTS:
oUI - Objref to the UI.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdCurveFitting, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIDataBottomTop
PURPOSE:
This function implements the user interface for the
Data Bottom/Top selections.
The result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIDataBottomTop(UI, Requester [, UVALUE=uvalue])
INPUTS:
UI object
Requester
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdDataBottomTop, get_screen_size
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitUIDisplayErrorObj
PURPOSE:
Provides the user interface for selecting an IDL command line
variable
CALLING SEQUENCE:
Result = IDLitUIFileOpen(oUI, Requester)
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
IDLitUIFileExit
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIFileExit(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIFileExport
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIFileExport(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITLANGCATQUERY
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIFileOpen
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIFileOpen(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITLANGCATQUERY, IDLITUIDIRECTORY
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIFileOpen
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIFileOpen(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITLANGCATQUERY
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIGridWizard
PURPOSE:
This function implements the user interface for the gridding wizard.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIGridWizard(oUI, oRequester)
INPUTS:
UI - UI objref.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdGridWizard
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIHourGlass
PURPOSE:
Impelments a ui service that sets the hourglass cursor
[Previous]
[Next]
NAME:
IDLitUIImportWizard
PURPOSE:
This function implements the user interface for the gridding wizard.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIImportWizard(oUI, oRequester)
INPUTS:
UI - UI objref.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdImportWizard
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIIntVol
PURPOSE:
This function implements the user interface for the Interval Volume
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIIntVol(UI, Requester [, UVALUE=uvalue])
INPUTS:
UI object
Requester - either a create or prop modify ooperation
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLitwdIsovalues, get_screen_size
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitUIIsoSurface
PURPOSE:
This function implements the user interface for the Isosurface
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIIsoSurface(UI, Requester [, UVALUE=uvalue])
INPUTS:
UI object
Requester - Usually an operation to create the isosurface or
an edit property operation to change the isosurface.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITLANGCATQUERY, IDLitwdIsovalues, get_screen_size
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitUIMacroEditor
PURPOSE:
This function implements the user interface for the Macro Editor
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIMacroEditor(UI, Requester)
INPUTS:
UI object
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdMacroEditor
MODIFICATION HISTORY:
Written by: AY, RSI, Jan 2004
Modified:
[Previous]
[Next]
NAME:
IDLituiMapGridLines
PURPOSE:
This function implements the user interface for the Gridlines
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiMapGridLines(oUI, Requester)
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLitwdPropertySheet, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2004
Modified:
[Previous]
[Next]
NAME:
IDLituiMapProjection
PURPOSE:
This function implements the user interface for Map Projections
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiMapProjection(oUI, Requester)
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLitwdPropertyPreview, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2004
Modified:
[Previous]
[Next]
NAME:
IDLitUIPaletteEditor
PURPOSE:
This function implements the user interface for the Palette Editor.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIPaletteEditor(UI, Requester [, UVALUE=uvalue])
INPUTS:
UI object
Requester - An object that has parameter data of type IDLPalette
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdPaletteEditor, get_screen_size
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitUIPrefs
PURPOSE:
This function implements the user interface for a simple prefs Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIPrefs(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLitwdBrowserPrefs
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitUIProgressBar
PURPOSE:
Provides the user interface for displaying a Progress Bar.
CALLING SEQUENCE:
Result = IDLitUIProgressBar(oUI, Requester)
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdProgressBar
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
IDLitUIPromptUser
PURPOSE:
Provides the user interface for selecting an IDL command line
variable
CALLING SEQUENCE:
KEYWORD PARAMETERS:
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
IDLitUIPromptUserText
PURPOSE:
UI Adaptor for prompting the user for text.
CALLING SEQUENCE:
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdPromptText
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
IDLituiRotateByAngle
PURPOSE:
This function implements the user interface for angle rotation
for the IDL iTool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiRotateByAngle(oUI, Requester)
INPUTS:
oUI - Objref to the UI.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdRotateByAngle, get_screen_size
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLituiRunMacro
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiRunMacro(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITWDRUNMACRO
MODIFICATION HISTORY:
Written by: AY, RSI, Dec 2003
Modified:
[Previous]
[Next]
CLASS_NAME:
IDLitUIService
PURPOSE:
This class implements the user-interface service connection
between the IDL Tool object and the UI tools.
SUPERCLASSES:
SUBCLASSES:
METHODS:
This class has the following methods:
IDLitUIService::Init
IDLitUIService::Cleanup
IDLitUIService::Register
IDLitUIService::DoUIService
INTERFACES:
CALLS: ***
IDLITUISERVICE::CLEANUP, IDLITUISERVICE::DOUISERVICE, IDLITUISERVICE::INIT
IDLITUISERVICE::REGISTER
[Previous]
[Next]
NAME:
IDLituiSplash
PURPOSE:
This function implements the user interface for the splash screen.
CALLING SEQUENCE:
Result = IDLituiSplash(oUI, Requester)
INPUTS:
oUI - Objref to the UI.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLITWDSPLASH
MODIFICATION HISTORY:
Written by: CT, RSI, June 2004
Modified:
[Previous]
[Next]
NAME:
IDLituiStyleApply
PURPOSE:
This function implements the user interface for the Style Browser
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiStyleApply(UI, Requester)
INPUTS:
UI object
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdStyleApply
MODIFICATION HISTORY:
Written by: CT, RSI, Dec 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUIStyleEditor
PURPOSE:
This function implements the user interface for the Style Editor
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUIStyleEditor(UI, Requester)
INPUTS:
UI object
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdStyleEditor
MODIFICATION HISTORY:
Written by: CT, RSI, Oct 2003
Modified:
[Previous]
[Next]
NAME:
IDLitUISubVolume
PURPOSE:
This function implements the user interface for the SubVolume
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLitUISubVolume(UI, Requester [, UVALUE=uvalue])
INPUTS:
UI object
Requester - either a create or prop modify ooperation
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLitwdSubVolume, get_screen_size
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitUISystem
PURPOSE:
Initializes the system us
CALLING SEQUENCE:
IDLitUISystem, oSystem
INPUTS:
oSystem - The system object
CALLED BY:
idlitsystem__define
[Previous]
[Next]
NAME:
IDLituiTextDisplay
PURPOSE:
This function implements the user interface for displaying text.
CALLING SEQUENCE:
Result = IDLituiTextDisplay(oUI, oRequester)
INPUTS:
oUI - Set this argument to the object reference for the UI.
oRequester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdTextdisplay
MODIFICATION HISTORY:
Written by: CT, RSI, September 2002
Modified:
[Previous]
[Next]
NAME:
IDLituiUnknownData
PURPOSE:
This function implements the user interface for unknown data import.
The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiUnknownData(oUI, oRequester)
INPUTS:
UI - UI objref.
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
CALLS: ***
IDLitwdUnknownData
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLituiWindowLayout
PURPOSE:
This function implements the user interface for file selection
for the IDL Tool. The Result is a success flag, either 0 or 1.
CALLING SEQUENCE:
Result = IDLituiWindowLayout(Requester [, UVALUE=uvalue])
INPUTS:
Requester - Set this argument to the object reference for the caller.
KEYWORD PARAMETERS:
UVALUE: User value data.
CALLS: ***
IDLITWDWINDOWLAYOUT
MODIFICATION HISTORY:
Written by: CT, RSI, Dec 2002
Modified:
[Previous]
[Next]
METHODNAME:
IDLitVisAxis::GetXYZRange
PURPOSE:
This function method overrides the _IDLitVisualization::GetXYZRange
function, taking into the tick labels.
CALLING SEQUENCE:
Success = Obj->[_IDLitVisualization::]GetXYZRange( $
xRange, yRange, zRange [, /NO_TRANSFORM])
ARGUMENTS
xRange: Set this argument to a named variable that upon return
will contain a two-element vector, [xmin, xmax], representing the
X range of the objects that impact the ranges.
yRange: Set this argument to a named variable that upon return
will contain a two-element vector, [ymin, ymax], representing the
Y range of the objects that impact the ranges.
zRange: Set this argument to a named variable that upon return
will contain a two-element vector, [zmin, zmax], representing the
Z range of the objects that impact the ranges.
KEYWORD PARAMETERS:
NO_TRANSFORM: Set this keyword to indicate that this Visualization's
model transform should not be applied when computing the XYZ ranges.
By default, the transform is applied.
DATA:
Handle the DATA keyword of the superclass. No change in behavior
is required in this method.
CALLS: ***
IDENTITY, IDLITGETRESOURCE, IDLITVISAXIS::ADD, IDLITVISAXIS::CLEANUP
IDLITVISAXIS::GETPROPERTY, IDLITVISAXIS::GETXYZRANGE, IDLITVISAXIS::INIT
IDLITVISAXIS::ONVIEWPORTCHANGE, IDLITVISAXIS::ONVIEWZOOM
IDLITVISAXIS::RESTORE, IDLITVISAXIS::SCALE, IDLITVISAXIS::SETPROPERTY
IDLITVISAXIS::TRANSLATE, IDLITVISAXIS::UPDATEAXISLOCATION
IDLITVISAXIS::UPDATEAXISTICKLEN, IDLITVISAXIS::UPDATESELECTIONVISUAL
IDLITVISAXIS::_REGISTERPROPERTIES, IDLITVISAXIS::_SETAXISSCALEDTICKLEN
IDLITVISAXIS::_UPDATENORMLOCATION, REVERSE
[Previous]
[Next]
IDLitVisAxis__Define
PURPOSE:
Defines the object structure for an IDLitVisAxis object.
CALLS: ***
IDENTITY, IDLITGETRESOURCE, IDLITVISAXIS::ADD, IDLITVISAXIS::CLEANUP
IDLITVISAXIS::GETPROPERTY, IDLITVISAXIS::GETXYZRANGE, IDLITVISAXIS::INIT
IDLITVISAXIS::ONVIEWPORTCHANGE, IDLITVISAXIS::ONVIEWZOOM
IDLITVISAXIS::RESTORE, IDLITVISAXIS::SCALE, IDLITVISAXIS::SETPROPERTY
IDLITVISAXIS::TRANSLATE, IDLITVISAXIS::UPDATEAXISLOCATION
IDLITVISAXIS::UPDATEAXISTICKLEN, IDLITVISAXIS::UPDATESELECTIONVISUAL
IDLITVISAXIS::_REGISTERPROPERTIES, IDLITVISAXIS::_SETAXISSCALEDTICKLEN
IDLITVISAXIS::_UPDATENORMLOCATION, REVERSE
[Previous]
[Next]
CLASS_NAME:
IDLitVisBackground
PURPOSE:
The IDLitVisBackground class is used for the background walls.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPolygon
SUBCLASSES:
METHODS:
Intrinisic Methods
IDLitVisBackground::Cleanup
IDLitVisBackground::Init
CALLS: ***
IDLITVISBACKGROUND::GETDATASTRING, IDLITVISBACKGROUND::GETHITVISUALIZATION
IDLITVISBACKGROUND::INIT, IDLITVISBACKGROUND::ONPROJECTIONCHANGE
IDLITVISBACKGROUND::RESTORE, IDLITVISBACKGROUND::SETPROPERTY
IDLITVISBACKGROUND::_UPDATEDATA
MODIFICATION HISTORY:
Written by: CT, Jan 2003
[Previous]
[Next]
METHODNAME:
IDLitVisBackground::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisBackground')
INPUTS:
KEYWORD PARAMETERS:
All keywords that can be used for IDLitVisPolygon
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITVISBACKGROUND::GETDATASTRING, IDLITVISBACKGROUND::GETHITVISUALIZATION
IDLITVISBACKGROUND::INIT, IDLITVISBACKGROUND::ONPROJECTIONCHANGE
IDLITVISBACKGROUND::RESTORE, IDLITVISBACKGROUND::SETPROPERTY
IDLITVISBACKGROUND::_UPDATEDATA
[Previous]
[Next]
IDLitVisBackground__Define
PURPOSE:
Defines the object structure for an IDLitVisBackground object.
CALLS: ***
IDLITVISBACKGROUND::GETDATASTRING, IDLITVISBACKGROUND::GETHITVISUALIZATION
IDLITVISBACKGROUND::INIT, IDLITVISBACKGROUND::ONPROJECTIONCHANGE
IDLITVISBACKGROUND::RESTORE, IDLITVISBACKGROUND::SETPROPERTY
IDLITVISBACKGROUND::_UPDATEDATA
[Previous]
[Next]
METHODNAME:
IDLitVisColorbar::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisColorbar::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisColorbar::Init followed by the word "Get"
can be retrieved using IDLitVisColorbar::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITVISCOLORBAR::CLEANUP, IDLITVISCOLORBAR::GETPROPERTY
IDLITVISCOLORBAR::INIT, IDLITVISCOLORBAR::ONDATACHANGEUPDATE
IDLITVISCOLORBAR::ONDATADISCONNECT, IDLITVISCOLORBAR::ONNOTIFY
IDLITVISCOLORBAR::RESTORE, IDLITVISCOLORBAR::SETPROPERTY
IDLITVISCOLORBAR::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisColorbar::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisColorbar::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisColorbar::Init followed by the word "Set"
can be set using IDLitVisColorbar::SetProperty.
CALLS: ***
IDLITVISCOLORBAR::CLEANUP, IDLITVISCOLORBAR::GETPROPERTY
IDLITVISCOLORBAR::INIT, IDLITVISCOLORBAR::ONDATACHANGEUPDATE
IDLITVISCOLORBAR::ONDATADISCONNECT, IDLITVISCOLORBAR::ONNOTIFY
IDLITVISCOLORBAR::RESTORE, IDLITVISCOLORBAR::SETPROPERTY
IDLITVISCOLORBAR::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisColorbar::OnDataDisconnect
Purpose:
This is called by the framework when a data item has disconnected
from a parameter on the surface.
Parameters:
ParmName - The name of the parameter that was disconnected.
CALLS: ***
IDLITVISCOLORBAR::CLEANUP, IDLITVISCOLORBAR::GETPROPERTY
IDLITVISCOLORBAR::INIT, IDLITVISCOLORBAR::ONDATACHANGEUPDATE
IDLITVISCOLORBAR::ONDATADISCONNECT, IDLITVISCOLORBAR::ONNOTIFY
IDLITVISCOLORBAR::RESTORE, IDLITVISCOLORBAR::SETPROPERTY
IDLITVISCOLORBAR::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisColorbar__Define
PURPOSE:
Defines the object structure for an IDLitVisColorbar object.
CALLS: ***
IDLITVISCOLORBAR::CLEANUP, IDLITVISCOLORBAR::GETPROPERTY
IDLITVISCOLORBAR::INIT, IDLITVISCOLORBAR::ONDATACHANGEUPDATE
IDLITVISCOLORBAR::ONDATADISCONNECT, IDLITVISCOLORBAR::ONNOTIFY
IDLITVISCOLORBAR::RESTORE, IDLITVISCOLORBAR::SETPROPERTY
IDLITVISCOLORBAR::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisContour::EnsureXYParameters
PURPOSE:
Ensure that X and Y parameters exist, based on the contour data
dimensions.
CALLING SEQUENCE:
Obj->[IDLitVisContour::]EnsureXYParameters
KEYWORD PARAMETERS:
None.
USAGE:
This is used by operations such as IDLitOpInsertImage, that need
the contour parameter in order to create an image based on the
contour and to be notified of changes to the contour.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISCONTOUR::CLEANUP
IDLITVISCONTOUR::EDITUSERDEFPROPERTY, IDLITVISCONTOUR::ENSUREXYPARAMETERS
IDLITVISCONTOUR::GETDATASTRING, IDLITVISCONTOUR::GETEXTENDEDDATASTRINGS
IDLITVISCONTOUR::GETLONLATRANGE, IDLITVISCONTOUR::GETPROPERTY
IDLITVISCONTOUR::INIT, IDLITVISCONTOUR::ONDATACHANGEUPDATE
IDLITVISCONTOUR::ONDATADISCONNECT, IDLITVISCONTOUR::ONDATARANGECHANGE
IDLITVISCONTOUR::ONPROJECTIONCHANGE, IDLITVISCONTOUR::RESTORE
IDLITVISCONTOUR::SETPARAMETER, IDLITVISCONTOUR::SETPROPERTY
IDLITVISCONTOUR::UPDATEOUTPUTPARAMETERS, IDLITVISCONTOUR::_DEGTODMS
IDLITVISCONTOUR::_FILLPARAMETER, IDLITVISCONTOUR::_GETDATALOCATION
IDLITVISCONTOUR::_GETLEVELS, IDLITVISCONTOUR::_GETXYDATA
IDLITVISCONTOUR::_LOADPALETTE, IDLITVISCONTOUR::_REGISTERPARAMETERS
IDLITVISCONTOUR::_REGISTERPROPERTIES
IDLITVISCONTOUR::_UPDATEDEFAULTINDICES, STRSPLIT
[Previous]
[Next]
METHODNAME:
IDLitVisContour::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
NOTE: This implementation currently assumes that no transformation
matrix is being applied between this Contour and the Subject sending
the notification.
CALLING SEQUENCE:
Obj->[IDLitVisContour::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
CALLS: ***
IDLITLANGCATQUERY, IDLITVISCONTOUR::CLEANUP
IDLITVISCONTOUR::EDITUSERDEFPROPERTY, IDLITVISCONTOUR::ENSUREXYPARAMETERS
IDLITVISCONTOUR::GETDATASTRING, IDLITVISCONTOUR::GETEXTENDEDDATASTRINGS
IDLITVISCONTOUR::GETLONLATRANGE, IDLITVISCONTOUR::GETPROPERTY
IDLITVISCONTOUR::INIT, IDLITVISCONTOUR::ONDATACHANGEUPDATE
IDLITVISCONTOUR::ONDATADISCONNECT, IDLITVISCONTOUR::ONDATARANGECHANGE
IDLITVISCONTOUR::ONPROJECTIONCHANGE, IDLITVISCONTOUR::RESTORE
IDLITVISCONTOUR::SETPARAMETER, IDLITVISCONTOUR::SETPROPERTY
IDLITVISCONTOUR::UPDATEOUTPUTPARAMETERS, IDLITVISCONTOUR::_DEGTODMS
IDLITVISCONTOUR::_FILLPARAMETER, IDLITVISCONTOUR::_GETDATALOCATION
IDLITVISCONTOUR::_GETLEVELS, IDLITVISCONTOUR::_GETXYDATA
IDLITVISCONTOUR::_LOADPALETTE, IDLITVISCONTOUR::_REGISTERPARAMETERS
IDLITVISCONTOUR::_REGISTERPROPERTIES
IDLITVISCONTOUR::_UPDATEDEFAULTINDICES, STRSPLIT
[Previous]
[Next]
METHODNAME:
IDLitVisContour::SetParameter
PURPOSE;
This procedure method associates a data object with the given
parameter.
CALLING SEQUENCE:
Obj->[IDLitVisContour::]SetParameter, ParamName, oItem
INPUTS:
ParamName: The name of the parameter to set.
oItem: The IDLitData object to be associated with the
given parameter.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISCONTOUR::CLEANUP
IDLITVISCONTOUR::EDITUSERDEFPROPERTY, IDLITVISCONTOUR::ENSUREXYPARAMETERS
IDLITVISCONTOUR::GETDATASTRING, IDLITVISCONTOUR::GETEXTENDEDDATASTRINGS
IDLITVISCONTOUR::GETLONLATRANGE, IDLITVISCONTOUR::GETPROPERTY
IDLITVISCONTOUR::INIT, IDLITVISCONTOUR::ONDATACHANGEUPDATE
IDLITVISCONTOUR::ONDATADISCONNECT, IDLITVISCONTOUR::ONDATARANGECHANGE
IDLITVISCONTOUR::ONPROJECTIONCHANGE, IDLITVISCONTOUR::RESTORE
IDLITVISCONTOUR::SETPARAMETER, IDLITVISCONTOUR::SETPROPERTY
IDLITVISCONTOUR::UPDATEOUTPUTPARAMETERS, IDLITVISCONTOUR::_DEGTODMS
IDLITVISCONTOUR::_FILLPARAMETER, IDLITVISCONTOUR::_GETDATALOCATION
IDLITVISCONTOUR::_GETLEVELS, IDLITVISCONTOUR::_GETXYDATA
IDLITVISCONTOUR::_LOADPALETTE, IDLITVISCONTOUR::_REGISTERPARAMETERS
IDLITVISCONTOUR::_REGISTERPROPERTIES
IDLITVISCONTOUR::_UPDATEDEFAULTINDICES, STRSPLIT
[Previous]
[Next]
IDLitVisContour__Define
PURPOSE:
Defines the object structure for an IDLitVisContour object.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISCONTOUR::CLEANUP
IDLITVISCONTOUR::EDITUSERDEFPROPERTY, IDLITVISCONTOUR::ENSUREXYPARAMETERS
IDLITVISCONTOUR::GETDATASTRING, IDLITVISCONTOUR::GETEXTENDEDDATASTRINGS
IDLITVISCONTOUR::GETLONLATRANGE, IDLITVISCONTOUR::GETPROPERTY
IDLITVISCONTOUR::INIT, IDLITVISCONTOUR::ONDATACHANGEUPDATE
IDLITVISCONTOUR::ONDATADISCONNECT, IDLITVISCONTOUR::ONDATARANGECHANGE
IDLITVISCONTOUR::ONPROJECTIONCHANGE, IDLITVISCONTOUR::RESTORE
IDLITVISCONTOUR::SETPARAMETER, IDLITVISCONTOUR::SETPROPERTY
IDLITVISCONTOUR::UPDATEOUTPUTPARAMETERS, IDLITVISCONTOUR::_DEGTODMS
IDLITVISCONTOUR::_FILLPARAMETER, IDLITVISCONTOUR::_GETDATALOCATION
IDLITVISCONTOUR::_GETLEVELS, IDLITVISCONTOUR::_GETXYDATA
IDLITVISCONTOUR::_LOADPALETTE, IDLITVISCONTOUR::_REGISTERPARAMETERS
IDLITVISCONTOUR::_REGISTERPROPERTIES
IDLITVISCONTOUR::_UPDATEDEFAULTINDICES, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitVisContourLevel
PURPOSE:
The IDLitVisContourLevel class is the wrapper for IDLgrContour levels.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITGETRESOURCE, IDLITVISCONTOURLEVEL::CLEANUP
IDLITVISCONTOURLEVEL::GETPROPERTY, IDLITVISCONTOURLEVEL::INIT
IDLITVISCONTOURLEVEL::ONVIEWPORTCHANGE, IDLITVISCONTOURLEVEL::ONVIEWZOOM
IDLITVISCONTOURLEVEL::SETPROPERTY, IDLITVISCONTOURLEVEL::_CREATETEXT
IDLITVISCONTOURLEVEL::_INSERTPROPERTY
IDLITVISCONTOURLEVEL::_REGISTERPROPERTIES
MODIFICATION HISTORY:
Written by: Karl, 06/29/2001
[Previous]
[Next]
METHODNAME:
IDLitVisContourLevel::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisContourLevel'[, Z[, X, Y]])
INPUTS:
Z: (see IDLgrContour)
X:
Y:
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrContour
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITGETRESOURCE, IDLITVISCONTOURLEVEL::CLEANUP
IDLITVISCONTOURLEVEL::GETPROPERTY, IDLITVISCONTOURLEVEL::INIT
IDLITVISCONTOURLEVEL::ONVIEWPORTCHANGE, IDLITVISCONTOURLEVEL::ONVIEWZOOM
IDLITVISCONTOURLEVEL::SETPROPERTY, IDLITVISCONTOURLEVEL::_CREATETEXT
IDLITVISCONTOURLEVEL::_INSERTPROPERTY
IDLITVISCONTOURLEVEL::_REGISTERPROPERTIES
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
Create just like an IDLgrContour.
[Previous]
[Next]
CLASS_NAME:
IDLitVisDataAxes
PURPOSE:
The IDLitVisDataAxes class is a collection of axes
that as a group serve as a visual representation for a data space.
CATEGORY:
Components
SUPERCLASSES:
_IDLitVisualization
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
METHODNAME:
IDLitVisDataAxes::Init
PURPOSE:
The IDLitVisDataAxes::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oDataAxes = OBJ_NEW('IDLitVisDataAxes')
or
Obj->[IDLitVisDataAxes::]Init
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
IDLitVisDataAxes::_UpdateAxesRanges
Purpose:
Internal routine to configure the axes.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
IDLitVisDataAxes::_GetAxis
Purpose:
Find an axis in the group matching the specified direction
and normLocation. If no axis is found, create an axis with
the specified properties and add it to the container.
Return the axis with the specified properties.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
IDLitVisDataAxes::ConfigAxes
Purpose:
Internal routine to configure the axes.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
METHODNAME:
IDLitVisDataAxes::GetProperty
PURPOSE:
The IDLitVisDataAxes::GetProperty procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisDataAxes::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisDataAxes::Init followed by the word "Get"
can be retrieved using IDLitVisDataAxes::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
METHODNAME:
IDLitVisDataAxes::SetProperty
PURPOSE:
The IDLitVisDataAxes::SetProperty procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisDataAxes::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisDataAxes::Init followed by the word "Set"
can be set using IDLitVisDataAxes::SetProperty.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
IDLitVisDataAxes::GetXYZRange
Purpose:
Override the GetXYZRange to add some padding for the tick labels.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
METHODNAME:
_IDLitVisDataAxes::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data
range has changed.
CALLING SEQUENCE:
Obj->[IDLitVisDataAxes::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new xrange, [ymin, ymax].
ZRange: The new xrange, [zmin, zmax].
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
IDLitVisDataAxes__Define
Purpose:
Defines the object structure for an IDLitVisDataAxes object.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATAAXES::ADD, IDLITVISDATAAXES::GETPROPERTY
IDLITVISDATAAXES::GETXYZRANGE, IDLITVISDATAAXES::INIT
IDLITVISDATAAXES::ONDATARANGECHANGE, IDLITVISDATAAXES::RESTORE
IDLITVISDATAAXES::SETPROPERTY, IDLITVISDATAAXES::_CONFIGAXES
IDLITVISDATAAXES::_GETAXIS, IDLITVISDATAAXES::_REGISTERPROPERTIES
IDLITVISDATAAXES::_UPDATEAXESRANGES
[Previous]
[Next]
CLASS_NAME:
IDLitVisDataSpace
PURPOSE:
The IDLitVisDataSpace class is a container for axes and visualizations
that share a common data space.
CATEGORY:
Components
SUPERCLASSES:
_IDLitVisualization
IDLitVisIDataSpace
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::Init
PURPOSE:
The IDLitVisDataSpace::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oDataSpace = OBJ_NEW('IDLitVisDataSpace')
or
Obj->[IDLitVisDataSpace::]Init
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisDataSpace::Init followed by the word "Get"
can be retrieved using IDLitVisDataSpace::GetProperty.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisDataSapce::Init followed by the word "Set"
can be set using IDLitVisDataSpace::SetProperty.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::_GetXYZAxisRange
PURPOSE:
The IDLitVisDataSpace::_GetXYZAxisRange procedure method gets the range
of the data space
CALLING SEQUENCE:
result = Obj->[IDLitVisDataSpace::]_GetXYZAxisRange, xrange, yrange, zrange
KEYWORDS:
NO_TRANSFORM - Set to not include the transform matrix.
XREVERSE - Set this keyword to a named variable that upon return
will contain a 1 if the X range needs to be reversed, or
a 0 otherwise.
YREVERSE - Set this keyword to a named variable that upon return
will contain a 1 if the Y range needs to be reversed, or
a 0 otherwise.
ZREVERSE - Set this keyword to a named variable that upon return
will contain a 1 if the Z range needs to be reversed, or
a 0 otherwise.
OUTPUTS:
result: 0 if all of the axes have no range (low and high range values
are equal). 1 otherwise.
xrange: A two-element vector, [xmin, xmax], representing
the X-axis range.
yrange: A two-element vector, [ymin, ymax], representing
the Y-axis range.
zrange: A two-element vector, [zmin, zmax], representing
the Z-axis range.
KEYWORD PARAMETERS:
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::_GetXYZAxisReverseFlags
PURPOSE:
The IDLitVisDataSpace::_GetXYZAxisReverseFlags procedure method
the boolean flags (one per axis direction) that indicate whether
the corresponding axis range is to be reversed.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]_GetXYZAxisReverseFlags, $
XReverse, YReverse, ZReverse
INPUTS:
XReverse - A named variable that upon return will contain a 1
if the X range needs to be reversed, or a 0 otherwise.
YReverse - A named variable that upon return will contain a 1
if the Y range needs to be reversed, or a 0 otherwise.
zReverse - A named variable that upon return will contain a 1
if the Z range needs to be reversed, or a 0 otherwise.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::OnDataRangeChange
PURPOSE:
The IDLitVisDataSpace::OnDataRangeChange procedure method
handles notification of an XYZ range change by updating the
extents of the axes within this data space.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification of
the range change.
XRange: A two-element vector, [xmin, xmax], representing
the X-axis range.
YRange: A two-element vector, [ymin, ymax], representing
the Y-axis range.
ZRange: A two-element vector, [zmin, zmax], representing
the Z-axis range.
KEYWORDS:
DATA_UPDATE: Set this keyword to a non-zero value to
indicate that this is being called as a result of
a data change (for one of the contained visualizations).
In this case, the automatic update flags for the x, y,
and z ranges will be honored. If this keyword is not
set, the ranges will be updated regarless of the automatic
update flags.
_WITHIN_DATA_COMPLETE: Internal keyword used to designate that
this method was called from this object's own
::OnDataComplete method, in which case, parent notifcation
can be reduced to a single corresponding ::OnDataComplete
call (rather than the typical ::OnDataChange plus
::OnDataComplete pair).
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::Add
PURPOSE:
This procedure method adds a visualization to the data space
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]Add, visualization
INPUTS:
visualization: the visualization to add to the Data Space
KEYWORD PARAMETERS:
Passed to the underlying routine.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::Remove
PURPOSE:
This procedure method removes a visualization to the data space
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]Remove, visualization
INPUTS:
visualization: the visualization to remove from the Data Space
KEYWORD PARAMETERS:
Passed to the underlying routine.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::Move
PURPOSE:
Override the move method so we can keep the
background & axes at the beginning and end.
pro IDLitVisDataSpace::Move, oldPosition, newPositionIn
compile_opt idl2, hidden
; Make sure my new position is between the walls and axes.
; (This will also move the walls & axes if necessary.)
validPositions = self->_CheckPositions()
newPosition = validPositions[0] > $
(newPositionIn < (validPositions[1]-1))
if (oldPosition eq newPosition) then $
return
; Move within our container. This will also handle keeping the
; manipulator visuals at the end.
self->_IDLitVisualization::Move, oldPosition, newPosition
end
----------------------------------------------------------------------------
METHODNAME:
IDLitVisDataSpace::_CheckDimensionChange
PURPOSE:
This procedure method determines whether the dimensionality of
this dataspace needs to be changed. If so, the ::Set3D
method will be called with the appropriate new 3D setting.
This overrides the _IDLitVisualization implementation of this
method. Special handling is required to ignore the wall and
axes.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]_CheckDimensionChange
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
SIDE EFFECTS:
If the dimensionality has changed, the ::Set3D method will
be called, causing the self.is3D field to be modified.
[Previous]
[Next]
IDLitVisDataSpace::GetXYZRange
Purpose:
Override the GetXYZRange to retrieve the range either from
the viz group, or from the axes if the viz group is empty.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitvisDataSpace::OnDataChange
PURPOSE:
This procedure method handles notification that the data has changed.
CALLING SEQUENCE:
Obj->[IDLitvisDataSpace::]OnDataChange, oSubject
INPUTS:
oSubject: A reference to the object sending notification
of the data change.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitvisDataSpace::OnDataComplete
PURPOSE:
The IDLitvisDataSpace::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oDataSpace->[IDLitvisDataSpace::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data flush.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::SetAxesRequest
PURPOSE:
This procedure method marks this dataspace as either requesting
axes, or not.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]SetAxesRequest[, axesRequest]
INPUTS:
axesRequest: A boolean indicating whether this visualization should
be marked as requesting axes. If this argument is not present, the
visualization will be marked as requesting axes.
KEYWORDS:
ALWAYS: Set this keyword to a non-zero value to indicate
that the given axes request always applies (as opposed to being
temporary).
AUTO_COMPUTE: Set this keyword to a non-zero value to
indicate that the axes request for this visualization should be
auto-computed based upon the axes requests of its contents.
This keyword is mutually exclusive of the ALWAYS keyword, and
if set, the axesRequest argument is ignored.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormSpace::SetAxesStyleRequest
PURPOSE:
This procedure method sets the axes style request for this
dataspace.
CALLING SEQUENCE:
Obj->[IDLitVisDataspace:]SetAxesStyleRequest[, styleRequest]
INPUTS:
styleRequest: A scalar representing the requested axes style.
Valid values include:
-1: this visualization no longer requests a particular axes style.
0-N: this visualization requests the corresponding style supported
by the IDLitVisDataAxes class.
KEYWORDS:
NO_NOTIFY: Set this keyword to a non-zero value to indicate
that the parent should not be notified of a change in axes
style request. By default, the parent is notified.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSapce::OnAxesStyleRequestChange
PURPOSE:
This procedure method handles notification that the axes style request
of a contained object has changed.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpace::]OnAxesRequestStyleChange, Subject, styleRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes style request change.
styleRequest: new style request setting of Subject.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::GetRequestedAxesStyle
PURPOSE:
This function method returns a scalar indicating the style
requested by this visualization. If none of the visualizations
in the hierarchy rooted at this visualization requested a particular
style, then -1 is returned.
CALLING SEQUENCE:
Result = Obj->[_IDLitVisualization::]GetRequestedAxesStyle()
OUTPUTS:
This function returns a scalar representing any of the non-zero
values supported by the IDLitVisDataAxes STYLE property, or
-1 to indicate that no specific request has been made.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::GetDataSpace
PURPOSE:
This function method retrieves the dataspace associated with
this object. [Note: this implementation overrides the implementation
within the _IDLitVisualization class.]
CALLING SEQUENCE:
oDataSpace = Obj->[IDLitVisDataSpace::]GetDataSpace()
INPUTS:
None.
KEYWORDS:
UNNORMALIZED: Set this keyword to a non-zero value to indicate
that the returned dataspace should subclass from 'IDLitVisDataSpace'
rather than 'IDLitVisNormDataSpace'.
OUTPUTS:
This function returns a reference to the dataspace associated
with this object, or a null object reference if no dataspace
is found.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpace::GetDataSpaceRoot
PURPOSE:
This function method retrieves the dataspace root that contains
this dataspace.
CALLING SEQUENCE:
oDataSpaceRoot = Obj->[IDLitVisDataSpace::]GetDataSpaceRoot()
INPUTS:
None.
OUTPUTS:
This function returns a reference to the dataspace root associated
with this object, or a null object reference if no dataspace root
is found.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
IDLitVisDataSpace__Define
Purpose:
Defines the object structure for an IDLitVisDataSpace object.
CALLS: ***
IDENTITY, IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISDATASPACE::ADD
IDLITVISDATASPACE::CLEANUP, IDLITVISDATASPACE::EDITUSERDEFPROPERTY
IDLITVISDATASPACE::GETAXES, IDLITVISDATASPACE::GETDATASPACE
IDLITVISDATASPACE::GETDATASPACEROOT, IDLITVISDATASPACE::GETDATASTRING
IDLITVISDATASPACE::GETPROJECTION, IDLITVISDATASPACE::GETPROPERTY
IDLITVISDATASPACE::GETREQUESTEDAXESSTYLE
IDLITVISDATASPACE::GETVISUALIZATIONS, IDLITVISDATASPACE::GETXYZRANGE
IDLITVISDATASPACE::INIT, IDLITVISDATASPACE::MOVE
IDLITVISDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACE::ONDATACHANGE, IDLITVISDATASPACE::ONDATACOMPLETE
IDLITVISDATASPACE::ONDATARANGECHANGE
IDLITVISDATASPACE::ONPROJECTIONCHANGE, IDLITVISDATASPACE::REMOVE
IDLITVISDATASPACE::REQUIRESDOUBLE, IDLITVISDATASPACE::RESTORE
IDLITVISDATASPACE::SET3D, IDLITVISDATASPACE::SETAXESREQUEST
IDLITVISDATASPACE::SETAXESSTYLEREQUEST
IDLITVISDATASPACE::SETPIXELDATASIZE, IDLITVISDATASPACE::SETPROPERTY
IDLITVISDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISDATASPACE::_CHECKPOSITIONS, IDLITVISDATASPACE::_GETMAPPROJECTION
IDLITVISDATASPACE::_GETXYZAXISRANGE
IDLITVISDATASPACE::_GETXYZAXISREVERSEFLAGS
IDLITVISDATASPACE::_REGISTERPROPERTIES, IDLITVISDATASPACE::_SETLOG
IDLITVISDATASPACE::_TESTPRECISION, IDLITVISDATASPACE::_UPDATEWALLS, REVERSE
[Previous]
[Next]
CLASS_NAME:
IDLitVisDataSpaceRoot
PURPOSE:
The IDLitVisDataSpaceRoot class is a container for "overlapping"
dataspaces that are manipulated as a group.
CATEGORY:
Components
SUPERCLASSES:
_IDLitVisualization
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::Init
PURPOSE:
The IDLitVisDataSpaceRoot::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oDataSpaceRoot = OBJ_NEW('IDLitVisDataSpaceRoot')
or
Obj->[IDLitVisDataSpaceRoot::]Init
KEYWORD PARAMETERS:
OUTPUTS:
This function method returns a 1 on success, or a 0 otherwise.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::Cleanup
PURPOSE:
The IDLitVisDataSpaceRoot::Cleanup procedure method preforms all
cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, oDataSpaceRoot
or
Obj->[IDLitVisDataSpaceRoot::]Cleanup
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::Add
PURPOSE:
This procedure method adds the given objects to the data space root.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot::]Add, Objects
INPUTS:
Objects: A reference (or vector of references) to the
Object(s) to add to the dataspace root.
KEYWORD PARAMETERS:
This procedure method accepts all keywords accepted by the
superclass's ::Add method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::Remove
PURPOSE:
This procedure method removes the given objects from the data space root.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot::]Remove, Objects
INPUTS:
Objects: A reference (or vector of references) to the
object(s) to add to the dataspace root.
KEYWORD PARAMETERS:
This procedure method accepts all keywords accepted by the
superclass's ::Remove method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::Set3D
PURPOSE:
This procedure method marks this dataspace root as being either 3D
or not 3D.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot::]Set3D[, Is3D]
INPUTS:
Is3D: A boolean indicating whether this visualization should
be marked as being 3D. If this argument is not present, the
visualization will be marked as 3D.
KEYWORDS:
ALWAYS: Set this keyword to a non-zero value to indicate
that the given 3D setting always applies (as opposed to being
temporary).
AUTO_COMPUTE: Set this keyword to a non-zero value to
indicate that the 3D value for this visualization should be
auto-computed based upon the dimensionality of its contents.
This keyword is mutually exclusive of the ALWAYS keyword, and
if set, the Is3D argument is ignored.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::IsIsotropic
PURPOSE:
This function method returns a flag indicating whether this dataspace root
is isotropic.
CALLING SEQUENCE:
Result = Obj->[IDLitVisDataspaceRoot::]IsIsotropic()
OUTPUTS:
This function returns a 1 if this visualization is isotropic,
or 0 otherwise.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitVisDataSpaceRoot::OnAxesRequestChange
PURPOSE:
This procedure method handles notification that the axes request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesRequestChange implementation
so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot:]OnAxesRequestChange, Subject, axesRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes request change.
axesRequest: new axes request setting of Subject.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitDataSpaceRoot::OnAxesStyleRequestChange
PURPOSE:
This procedure method handles notification that the axes style request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesStyleRequestChange
implementation so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot:]OnAxesStyleRequestChange, Subject,styleRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes style request change.
styleRequest: new style request setting of Subject.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
METHODNAME:
IDLitvisDataSpaceRoot::OnDataComplete
PURPOSE:
The IDLitvisDataSpaceRoot::OnDataComplete procedure method handles
notification that recent data changes are complete.
CALLING SEQUENCE:
oDataSpaceRoot->[IDLitvisDataSpaceRoot::]OnDataComplete, oNotifier
INPUTS:
oNotifier: A reference to the object sending notification
of the data flush.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
IDLitVisDataSpaceRoot::GetCurrentDataSpace
PURPOSE:
This function method returns a reference to the currently active
dataspace contained by this root.
CALLING SEQUENCE:
oDataSpace = Obj->[IDLitVisDataSpaceRoot::]GetCurrentDataSpace()
OUTPUTS:
This function method returns a reference to an object that inherits
from IDLitVisIDataSpace.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
SIDE EFFECTS:
If no dataspace is active, the first contained dataspace is
returned. If no dataspace is contained, then it is created and
returned.
[Previous]
[Next]
IDLitVisDataSpaceRoot::SetCurrentDataSpace
PURPOSE:
This procedure method sets the currently active dataspace within
this root container to the given dataspace.
CALLING SEQUENCE:
Obj->[IDLitVisDataSpaceRoot::]SetCurrentDataSpace, DataSpace
INPUTS:
DataSpace: A reference to an IDLitVisIDataSpace object that is
to become the current dataspace.
pro IDLitVisDataSpaceRoot::SetCurrentDataSpace, oDataSpace
compile_opt hidden, idl2
; Verify that the given DataSpace is contained within this root.
if (self->IsContained(oDataSpace) eq 0) then begin
;; Don't change from the present.
return
endif
self.oCurrDataSpace = oDataSpace
end
----------------------------------------------------------------------------
IDLitVisDataSpaceRoot::Reset
Purpose:
This procedure method resets the transform matrix for this
dataspace root to identity.
Keywords:
NO_NOTIFY: Set this keyword to indicate that notification should
not be broadcast to observers.
pro IDLitVisDataSpaceRoot::Reset, NO_NOTIFY=noNotify
compile_opt idl2, hidden
t = [[1.0,0,0,0], $
[0.0,1,0,0], $
[0.0,0,1,0], $
[0.0,0,0,1]]
self->SetProperty, TRANSFORM=t, NO_NOTIFY=noNotify
end
----------------------------------------------------------------------------
Object Definition
----------------------------------------------------------------------------
----------------------------------------------------------------------------
+
IDLitVisDataSpaceRoot__Define
Purpose:
Defines the object structure for an IDLitVisDataSpaceRoot object.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISDATASPACEROOT::ADD
IDLITVISDATASPACEROOT::GETCURRENTDATASPACE, IDLITVISDATASPACEROOT::INIT
IDLITVISDATASPACEROOT::ISISOTROPIC
IDLITVISDATASPACEROOT::ONAXESREQUESTCHANGE
IDLITVISDATASPACEROOT::ONAXESSTYLEREQUESTCHANGE
IDLITVISDATASPACEROOT::ONDATACOMPLETE, IDLITVISDATASPACEROOT::REMOVE
IDLITVISDATASPACEROOT::RESET, IDLITVISDATASPACEROOT::RESTORE
IDLITVISDATASPACEROOT::SET3D, IDLITVISDATASPACEROOT::SETCURRENTDATASPACE
IDLITVISDATASPACEROOT::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitVisGrObject
PURPOSE:
The IDLitVisGrObject class implements a generic visualization
object that can contain any IDL gr Object.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISGROBJECT::CLEANUP, IDLITVISGROBJECT::GETTYPES
IDLITVISGROBJECT::INIT, IDLITVISGROBJECT::ONDATACHANGEUPDATE
IDLITVISGROBJECT::ONDATADISCONNECT
[Previous]
[Next]
IDLitVisGrObject__Define
PURPOSE:
Defines the object structure for an IDLitVisGrObject object.
CALLS: ***
IDLITVISGROBJECT::CLEANUP, IDLITVISGROBJECT::GETTYPES
IDLITVISGROBJECT::INIT, IDLITVISGROBJECT::ONDATACHANGEUPDATE
IDLITVISGROBJECT::ONDATADISCONNECT
[Previous]
[Next]
CLASS_NAME:
IDLitVisGroup
PURPOSE:
This class represents a group of IDLitVisualizations.
CALLS: ***
IDLITVISGROUP::ADD, IDLITVISGROUP::GETXYZRANGE, IDLITVISGROUP::INIT
[Previous]
[Next]
IDLitVisGroup__Define
PURPOSE:
Defines the object structure for an IDLitVisGroup object.
CALLS: ***
IDLITVISGROUP::ADD, IDLITVISGROUP::GETXYZRANGE, IDLITVISGROUP::INIT
[Previous]
[Next]
METHODNAME:
IDLitVisHistogram::Init
PURPOSE:
Initialize this component
KEYWORD PARAMETERS:
All keywords that can be used for IDLitVisPlot
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITVISHISTOGRAM::GETPROPERTY, IDLITVISHISTOGRAM::INIT
IDLITVISHISTOGRAM::ONDATACHANGEUPDATE, IDLITVISHISTOGRAM::SETPROPERTY
IDLITVISHISTOGRAM::_UPDATEHISTOGRAM
[Previous]
[Next]
CLASS_NAME:
IDLitVisIDataSpace
PURPOSE:
The IDLitVisIDataSpace class represents an interface for visualization
data space functionality.
It is intended that other framework components will sub-class from
this class and thereby identify themselves as implementing the
data space interface.
CATEGORY:
Components
SUPERCLASSES:
None.
CREATION:
See IDLitVisIDataSpace::Init
METHODS:
Intrinsic Methods
IDLitVisIDataSpace::Init
IDLitVisIDataSpace::Cleanup
IIDLDataRangeObserver Interface
_IDLitVisualization::OnDataRangeChange
MODIFICATION HISTORY:
Written by:
[Previous]
[Next]
METHODNAME:
IDLitVisIDataSpace::OnDataRangeChange
PURPOSE:
The IDLitVisIDataSpace::OnDataRangeChange procedure method handles
notification of an XYZ range change.
CALLING SEQUENCE:
Obj->[IDLitVisIDataSpace::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification of
the range change.
XRange: A two-element vector, [xmin, xmax], representing
the X-axis range.
YRange: A two-element vector, [ymin, ymax], representing
the Y-axis range.
ZRange: A two-element vector, [zmin, zmax], representing
the Z-axis range.
[Previous]
[Next]
IDLitVisIDataSpace__Define
Purpose:
Defines the object structure for an IDLitVisIDataSpace object.
[Previous]
[Next]
METHODNAME:
IDLitVisImage::Init
PURPOSE:
This function method initializes the component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisImage')
or
Obj->[IDLitVisImage::]Init
KEYWORD PARAMETERS:
This function method accepts all keywords accepted by the
::Init methods of the superclasses. In addition, the following
keywords are supported:
DATA (Set): Set this keyword to an array representing the data
to be associated with this image. The array should be a 2D
or 3D array.
IMAGE_TRANSPARENCY (Get, Set): Set this keyword to a value
between 0 and 100 indicating the percentage that this image
is to appear transparent. The default is 0 (i.e. fully opaque).
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisImage::]Cleanup
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::GetProperty
PURPOSE:
This procedure method retrieves the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]GetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::GetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisImage::Init followed by the word "Get" can be retrieved
using IDLitVisImage::GetProperty. In addition, the following keywords
are supported:
BYTESCALE_MIN: Set this keyword to a named variable that upon return
will contain a vector (one element per image plane) indicating the
minimum value used for bytescale display of this image.
BYTESCALE_MAX: Set this keyword to a named variable that upon return
will contain a vector (one element per image plane) indicating the
maximum value used for bytescale display of this image.
IMAGE_TRANSPARENCY: Set this keyword to a named variable that upon
return will contain a scalar representing the transparency factor
(in the range from 0 to 100) to be applied when displaying this image.
PIXEL_XSIZE: Set this keyword to a named variable that upon return
will contain a scalar representing the size of an image pixel in X,
measured in data units.
PIXEL_YSIZE: Set this keyword to a named variable that upon return
will contain a scalar representing the size of an image pixel in X,
measured in data units.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::EnsureXYParameters
PURPOSE:
Ensure that X and Y parameters exist, based on the image dimensions,
origin and pixel size.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]EnsureXYParameters
KEYWORD PARAMETERS:
None.
USAGE:
This is used by operations such as IDLitOpInsertContour, that need
the image parameter in order to create a contour based on the
image and to be notified of changes to the image.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::SetProperty
PURPOSE:
This procedure method sets the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]SetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::SetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisImage::Init followed by the word "Set" can be retrieved
using IDLitVisImage::SetProperty.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::DoApplyByteScale
PURPOSE:
This function method determines whether bytescaling should be
applied or not.
CALLING_SEQUENCE:
Result = Obj->[IDLitVisImage::]DoApplyByteScale()
Keywords:
IMAGE_DATA: Set this keyword to a scalar or vector of pointers,
with each one pointing to a different image channel.
If not provided, the image data pointers will be retrieved
from this object's parameters.
(This keyword is provided primarily as an optimization so that if
the image data had already been retrieved, it can just be passed
along.)
N_PLANES: Set this keyword to a named variable that upon return
will contain a scalar representing the number of planes in the
image data.
OUTPUTS:
This function method returns 1 if bytescaling is to be applied,
or 0 if not.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::GetByteScaleDataRange
PURPOSE:
This function method returns the full data range within which
the bytescale min/max for this image must fall.
The range is selected as follows:
- If the image data is type byte:
dataRange = [0,255]
return value = 1
- If the image data is any other type:
- If the data range was explicitly set (via the
BYTESCALE_DATARANGE keyword to ::SetProperty),
dataRange = BYTESCALE_DATARANGE
return value = 1
- Otherwise:
dataRange needs to be automatically computed
(based upon the min and max data value per channel).
In this case:
dataRange = [0.0,1.0] ; values are irrelevant
return value = 0
CALLING_SEQUENCE:
Result = Obj->[IDLitVisImage::]GetByteScaleDataRange(dataRange)
Arguments:
dataRange: Upon return, this argument will be set to a two-element
vector, [min,max], representing the data range (as described
in the above comments).
Return value:
This function returns a 1 if the data range can be used as
provided, or a 0 if the dataRange needs to be automatically
computed per (based upon the min and max data value per
channel).
OUTPUTS:
This function method returns 1 if a byte range is to be used,
or 0 if not.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the IDLgrImage object.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]OnDataChangeUpdate, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the image) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
Then, it puts the data in the IDLgrImage object.
KEYWORD PARAMETERS:
NO_SUBRECT_UPDATE: Set this keyword to a non-zero value to indicate
that the sub-image rectangle associated with this image should
not be updated.
[This keyword is provided primarily so that when the parameter set
is updated, it can call ::OnDataChange for each of the contained
data items without updating the sub-image rectangle on each call.]
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::OnWorldDimensionChange
PURPOSE:
This procedure method handles notification that the dimensionality
of the parent world has changed.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]OnWorldDimensionChange, Subject, is3D
INPUTS:
Subject: A reference to the object sending notification
of the dimensionality change.
is3D: new 3D setting of Subject.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::QueryPixelScaleStatus()
PURPOSE:
This function method reports whether it is a good candidate
for a pixel scale operation.
An image is considered a good candidate if:
- it has not been rotated
- it's parent "world" has not been rotated
- it is contained within a 2D dataspace.
CALLING SEQUENCE:
Result = Obj->[IDLitVisImage::]QueryPixelScaleStatus()
OUTPUTS:
This function method returns:
0 if this image is not a good candidate for pixel scaling
1 if this image is a good candidate for pixel scaling
-1 if this image is currently not a good candidate for
pixel scaling, but this status could change by simply
resetting the transform of the dataspace root to identity.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::On2DRotate
PURPOSE:
This procedure method handles notification that a parent
dataspace's rotation status has changed.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]On2DRotate, Subject, isRotated
INPUTS:
Subject: A reference to the object sending notification
of the rotation change.
isRotated: new flag indicating whether the subject is rotated or not.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
METHODNAME:
IDLitVisImage::GetXYZRange
PURPOSE:
This function method overrides the _IDLitVisualization::GetXYZRange
function so that the /DATA keyword is handled properly for
images.
CALLING SEQUENCE:
Success = Obj->[IDLitVisImage::]GetXYZRange( $
xRange, yRange, zRange [, /DATA] [, /NO_TRANSFORM])
INPUTS:
xRange: Set this argument to a named variable that upon return
will contain a two-element vector, [xmin, xmax], representing the
X range of the objects that impact the ranges.
yRange: Set this argument to a named variable that upon return
will contain a two-element vector, [ymin, ymax], representing the
Y range of the objects that impact the ranges.
zRange: Set this argument to a named variable that upon return
will contain a two-element vector, [zmin, zmax], representing the
Z range of the objects that impact the ranges.
KEYWORD PARAMETERS:
DATA: Set this keyword to a nonzero value to indicate that
the ranges should be computed for the full datasets of the
contents of this visualization. By default (if the keyword is
not set), the ranges are computed for the visualized portions
of the data sets.
NO_TRANSFORM: Set this keyword to indicate that this Visualization's
model transform should not be applied when computing the XYZ ranges.
By default, the transform is applied.
OUTPUTS:
This function returns a 1 if retrieval of the XYZ ranges was
successful, or 0 otherwise.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
IDLitVisImage__Define
PURPOSE:
Defines the object structure for an IDLitVisImage object.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISIMAGE::CLEANUP, IDLITVISIMAGE::DATASPACETOVIS
IDLITVISIMAGE::DOAPPLYBYTESCALE, IDLITVISIMAGE::EDITUSERDEFPROPERTY
IDLITVISIMAGE::ENSUREPALETTE, IDLITVISIMAGE::ENSUREXYPARAMETERS
IDLITVISIMAGE::GETBYTESCALEDATARANGE, IDLITVISIMAGE::GETDATASTRING
IDLITVISIMAGE::GETEXTENDEDDATASTRINGS, IDLITVISIMAGE::GETLONLATRANGE
IDLITVISIMAGE::GETPARAMETER, IDLITVISIMAGE::GETPROPERTY
IDLITVISIMAGE::GETXYZRANGE, IDLITVISIMAGE::INIT, IDLITVISIMAGE::ON2DROTATE
IDLITVISIMAGE::ONDATACHANGEUPDATE, IDLITVISIMAGE::ONDATADISCONNECT
IDLITVISIMAGE::ONDATARANGECHANGE, IDLITVISIMAGE::ONPROJECTIONCHANGE
IDLITVISIMAGE::ONWORLDDIMENSIONCHANGE
IDLITVISIMAGE::QUERYPIXELSCALESTATUS, IDLITVISIMAGE::RESTORE
IDLITVISIMAGE::SETDATA, IDLITVISIMAGE::SETORIGIN, IDLITVISIMAGE::SETPROPERTY
IDLITVISIMAGE::VISTODATASPACE, IDLITVISIMAGE::_DEGTODMS
IDLITVISIMAGE::_GETDATADIMENSIONS, IDLITVISIMAGE::_GETIMAGEDIMENSIONS
IDLITVISIMAGE::_GETMAPPROJECTION, IDLITVISIMAGE::_REGISTERPROPERTIES
IDLITVISIMAGE::_REPOSITIONREGIONS, IDLITVISIMAGE::_SETSUBRECT
IDLITVISIMAGE::_UPDATEIMAGEDATA, IDLITVISIMAGE::_UPDATEMAPPROJECTION
IDLITVISIMAGE::_UPDATEREGIONPIXELS, STRSPLIT, map_proj_image
[Previous]
[Next]
CLASS_NAME:
IDLitVisImagePlane
PURPOSE:
The IDLitVisImagePlane class implements image planes for volumes
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::Init
PURPOSE:
This function method initializes the component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisImagePlane')
or
Obj->[IDLitVisImagePlane::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisImagePlane::]Cleanup
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::GetProperty
PURPOSE:
This procedure method retrieves the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]GetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::GetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisImagePlane::Init followed by the word "Get" can be retrieved
using IDLitVisImagePlanen::GetProperty.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::SetProperty
PURPOSE:
This procedure method sets the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]SetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::SetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisImagePlane::Init followed by the word "Set" can be retrieved
using IDLitVisImagePlane::SetProperty.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::_CreateGraphics
PURPOSE:
Heavyweight creation - make graphic objects.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]_CreateGraphics
INPUTS:
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::_InitImagePlane
PURPOSE:
This procedure method set the initial position of an image plane.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]_InitImagePlane
INPUTS:
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::_UpdateImagePlane
PURPOSE:
This procedure method updates the image data for the
image plane.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]_UpdateImagePlane
INPUTS:
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::OnNotify
PURPOSE:
This procedure method handles notification of changes from a Subject
we have subscribed to.
In this case, we are watching the volume object that this image plane
belongs to.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]OnDataChangeUpdate, strItem, strMsg, strUser
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
METHODNAME:
IDLitVisImagePlane::OnDataChangeUpdate
PURPOSE:
This procedure method handles notification that the data has changed.
CALLING SEQUENCE:
Obj->[IDLitVisImagePlane::]OnDataChangeUpdate, Subject
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
IDLitVisImagePlane__Define
PURPOSE:
Defines the object structure.
CALLS: ***
EXTRACT_SLICE, IDLITVISIMAGEPLANE::CLEANUP, IDLITVISIMAGEPLANE::GETPROPERTY
IDLITVISIMAGEPLANE::INIT, IDLITVISIMAGEPLANE::ONDATACHANGEUPDATE
IDLITVISIMAGEPLANE::ONNOTIFY, IDLITVISIMAGEPLANE::SCALE
IDLITVISIMAGEPLANE::SETPROPERTY, IDLITVISIMAGEPLANE::TRANSLATE
IDLITVISIMAGEPLANE::VISTOWINDOW, IDLITVISIMAGEPLANE::WINDOWTOVIS
IDLITVISIMAGEPLANE::_CREATEGRAPHICS, IDLITVISIMAGEPLANE::_INITIMAGEPLANE
IDLITVISIMAGEPLANE::_UPDATEIMAGEPLANE
[Previous]
[Next]
CLASS_NAME:
IDLitVisIntVol
PURPOSE:
The IDLitVisIntVol class implements an Interval Volume visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITLANGCATQUERY, IDLITVISINTVOL::CLEANUP
IDLITVISINTVOL::EDITUSERDEFPROPERTY, IDLITVISINTVOL::GETPROPERTY
IDLITVISINTVOL::INIT, IDLITVISINTVOL::ONDATACHANGEUPDATE
IDLITVISINTVOL::ONDATADISCONNECT, IDLITVISINTVOL::RESTORE
IDLITVISINTVOL::SETPROPERTY, IDLITVISINTVOL::_DECIMATECALLBACK
IDLITVISINTVOL::_GENERATEINTERVALVOLUME, IDLITVISINTVOL::_PROGRESSCALLBACK
IDLITVISINTVOL::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIntVol::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisIntVol::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisIntVol::Init followed by the word "Get"
can be retrieved using IDLitVisIntVol::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISINTVOL::CLEANUP
IDLITVISINTVOL::EDITUSERDEFPROPERTY, IDLITVISINTVOL::GETPROPERTY
IDLITVISINTVOL::INIT, IDLITVISINTVOL::ONDATACHANGEUPDATE
IDLITVISINTVOL::ONDATADISCONNECT, IDLITVISINTVOL::RESTORE
IDLITVISINTVOL::SETPROPERTY, IDLITVISINTVOL::_DECIMATECALLBACK
IDLITVISINTVOL::_GENERATEINTERVALVOLUME, IDLITVISINTVOL::_PROGRESSCALLBACK
IDLITVISINTVOL::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIntVol::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisIntVol::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisIntVol::Init followed by the word "Set"
can be set using IDLitVisIntVol::SetProperty.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISINTVOL::CLEANUP
IDLITVISINTVOL::EDITUSERDEFPROPERTY, IDLITVISINTVOL::GETPROPERTY
IDLITVISINTVOL::INIT, IDLITVISINTVOL::ONDATACHANGEUPDATE
IDLITVISINTVOL::ONDATADISCONNECT, IDLITVISINTVOL::RESTORE
IDLITVISINTVOL::SETPROPERTY, IDLITVISINTVOL::_DECIMATECALLBACK
IDLITVISINTVOL::_GENERATEINTERVALVOLUME, IDLITVISINTVOL::_PROGRESSCALLBACK
IDLITVISINTVOL::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIntVol::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the object.
CALLING SEQUENCE:
Obj->[IDLitVisIntVol::]OnDataChangeUpdate, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the surface) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITLANGCATQUERY, IDLITVISINTVOL::CLEANUP
IDLITVISINTVOL::EDITUSERDEFPROPERTY, IDLITVISINTVOL::GETPROPERTY
IDLITVISINTVOL::INIT, IDLITVISINTVOL::ONDATACHANGEUPDATE
IDLITVISINTVOL::ONDATADISCONNECT, IDLITVISINTVOL::RESTORE
IDLITVISINTVOL::SETPROPERTY, IDLITVISINTVOL::_DECIMATECALLBACK
IDLITVISINTVOL::_GENERATEINTERVALVOLUME, IDLITVISINTVOL::_PROGRESSCALLBACK
IDLITVISINTVOL::_SETCOLOR
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
IDLitVisIntVol__Define
PURPOSE:
Defines the object structure for an IDLitVisIntVol object.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISINTVOL::CLEANUP
IDLITVISINTVOL::EDITUSERDEFPROPERTY, IDLITVISINTVOL::GETPROPERTY
IDLITVISINTVOL::INIT, IDLITVISINTVOL::ONDATACHANGEUPDATE
IDLITVISINTVOL::ONDATADISCONNECT, IDLITVISINTVOL::RESTORE
IDLITVISINTVOL::SETPROPERTY, IDLITVISINTVOL::_DECIMATECALLBACK
IDLITVISINTVOL::_GENERATEINTERVALVOLUME, IDLITVISINTVOL::_PROGRESSCALLBACK
IDLITVISINTVOL::_SETCOLOR
[Previous]
[Next]
CLASS_NAME:
IDLitVisIsosurface
PURPOSE:
The IDLitVisIsosurface class implements a a polygon visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISISOSURFACE::CLEANUP, IDLITVISISOSURFACE::EDITUSERDEFPROPERTY
IDLITVISISOSURFACE::GETPROPERTY, IDLITVISISOSURFACE::INIT
IDLITVISISOSURFACE::ONDATACHANGEUPDATE
IDLITVISISOSURFACE::ONDATADISCONNECT, IDLITVISISOSURFACE::RESTORE
IDLITVISISOSURFACE::SETPROPERTY, IDLITVISISOSURFACE::_DECIMATECALLBACK
IDLITVISISOSURFACE::_GENERATEISOSURFACE
IDLITVISISOSURFACE::_PROGRESSCALLBACK, IDLITVISISOSURFACE::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIsosurface::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisIsosurface::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisIsosurface::Init followed by the word "Get"
can be retrieved using IDLitVisIsosurface::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITVISISOSURFACE::CLEANUP, IDLITVISISOSURFACE::EDITUSERDEFPROPERTY
IDLITVISISOSURFACE::GETPROPERTY, IDLITVISISOSURFACE::INIT
IDLITVISISOSURFACE::ONDATACHANGEUPDATE
IDLITVISISOSURFACE::ONDATADISCONNECT, IDLITVISISOSURFACE::RESTORE
IDLITVISISOSURFACE::SETPROPERTY, IDLITVISISOSURFACE::_DECIMATECALLBACK
IDLITVISISOSURFACE::_GENERATEISOSURFACE
IDLITVISISOSURFACE::_PROGRESSCALLBACK, IDLITVISISOSURFACE::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIsosurface::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisIsosurface::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisIsosurface::Init followed by the word "Set"
can be set using IDLitVisIsosurface::SetProperty.
CALLS: ***
IDLITVISISOSURFACE::CLEANUP, IDLITVISISOSURFACE::EDITUSERDEFPROPERTY
IDLITVISISOSURFACE::GETPROPERTY, IDLITVISISOSURFACE::INIT
IDLITVISISOSURFACE::ONDATACHANGEUPDATE
IDLITVISISOSURFACE::ONDATADISCONNECT, IDLITVISISOSURFACE::RESTORE
IDLITVISISOSURFACE::SETPROPERTY, IDLITVISISOSURFACE::_DECIMATECALLBACK
IDLITVISISOSURFACE::_GENERATEISOSURFACE
IDLITVISISOSURFACE::_PROGRESSCALLBACK, IDLITVISISOSURFACE::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisIsosurface::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the object.
CALLING SEQUENCE:
Obj->[IDLitVisIsosurface::]OnDataChangeUpdate, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the surface) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITVISISOSURFACE::CLEANUP, IDLITVISISOSURFACE::EDITUSERDEFPROPERTY
IDLITVISISOSURFACE::GETPROPERTY, IDLITVISISOSURFACE::INIT
IDLITVISISOSURFACE::ONDATACHANGEUPDATE
IDLITVISISOSURFACE::ONDATADISCONNECT, IDLITVISISOSURFACE::RESTORE
IDLITVISISOSURFACE::SETPROPERTY, IDLITVISISOSURFACE::_DECIMATECALLBACK
IDLITVISISOSURFACE::_GENERATEISOSURFACE
IDLITVISISOSURFACE::_PROGRESSCALLBACK, IDLITVISISOSURFACE::_SETCOLOR
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
IDLitVisIsosurface__Define
PURPOSE:
Defines the object structure for an IDLitVisIsosurface object.
CALLS: ***
IDLITVISISOSURFACE::CLEANUP, IDLITVISISOSURFACE::EDITUSERDEFPROPERTY
IDLITVISISOSURFACE::GETPROPERTY, IDLITVISISOSURFACE::INIT
IDLITVISISOSURFACE::ONDATACHANGEUPDATE
IDLITVISISOSURFACE::ONDATADISCONNECT, IDLITVISISOSURFACE::RESTORE
IDLITVISISOSURFACE::SETPROPERTY, IDLITVISISOSURFACE::_DECIMATECALLBACK
IDLITVISISOSURFACE::_GENERATEISOSURFACE
IDLITVISISOSURFACE::_PROGRESSCALLBACK, IDLITVISISOSURFACE::_SETCOLOR
[Previous]
[Next]
METHODNAME:
IDLitVisLegend::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisLegend'[, Z[, X, Y]])
INPUTS:
Z: (see IDLgrImage)
X:
Y:
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrImage
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITVISLEGEND::ADD, IDLITVISLEGEND::ADDTOLEGEND, IDLITVISLEGEND::CLEANUP
IDLITVISLEGEND::GETHITVISUALIZATION, IDLITVISLEGEND::GETPROPERTY
IDLITVISLEGEND::INIT, IDLITVISLEGEND::MOVE
IDLITVISLEGEND::ONDATACHANGEUPDATE, IDLITVISLEGEND::ONNOTIFY
IDLITVISLEGEND::ONVIEWPORTCHANGE, IDLITVISLEGEND::ONVIEWZOOM
IDLITVISLEGEND::RECOMPUTELAYOUT, IDLITVISLEGEND::REMOVE
IDLITVISLEGEND::RESTORE, IDLITVISLEGEND::SETPROPERTY
IDLITVISLEGEND::TRANSLATE, IDLITVISLEGEND::_REGISTERPROPERTIES
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
Create just like an IDLgrImage.
[Previous]
[Next]
METHODNAME:
IDLitVisLegend::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLegend::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisLegend::Init followed by the word "Get"
can be retrieved using IDLitVisLegend::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
IDLITVISLEGEND::ADD, IDLITVISLEGEND::ADDTOLEGEND, IDLITVISLEGEND::CLEANUP
IDLITVISLEGEND::GETHITVISUALIZATION, IDLITVISLEGEND::GETPROPERTY
IDLITVISLEGEND::INIT, IDLITVISLEGEND::MOVE
IDLITVISLEGEND::ONDATACHANGEUPDATE, IDLITVISLEGEND::ONNOTIFY
IDLITVISLEGEND::ONVIEWPORTCHANGE, IDLITVISLEGEND::ONVIEWZOOM
IDLITVISLEGEND::RECOMPUTELAYOUT, IDLITVISLEGEND::REMOVE
IDLITVISLEGEND::RESTORE, IDLITVISLEGEND::SETPROPERTY
IDLITVISLEGEND::TRANSLATE, IDLITVISLEGEND::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisLegend::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLegend::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisLegend::Init followed by the word "Set"
can be set using IDLitVisLegend::SetProperty.
CALLS: ***
IDLITVISLEGEND::ADD, IDLITVISLEGEND::ADDTOLEGEND, IDLITVISLEGEND::CLEANUP
IDLITVISLEGEND::GETHITVISUALIZATION, IDLITVISLEGEND::GETPROPERTY
IDLITVISLEGEND::INIT, IDLITVISLEGEND::MOVE
IDLITVISLEGEND::ONDATACHANGEUPDATE, IDLITVISLEGEND::ONNOTIFY
IDLITVISLEGEND::ONVIEWPORTCHANGE, IDLITVISLEGEND::ONVIEWZOOM
IDLITVISLEGEND::RECOMPUTELAYOUT, IDLITVISLEGEND::REMOVE
IDLITVISLEGEND::RESTORE, IDLITVISLEGEND::SETPROPERTY
IDLITVISLEGEND::TRANSLATE, IDLITVISLEGEND::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisLegend::OnDataChange
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the IDLgrImage object.
CALLING SEQUENCE:
Obj->[IDLitVisLegend::]OnDataChange, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the image) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
Then, it puts the data in the IDLgrImage object.
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
IDLITVISLEGEND::ADD, IDLITVISLEGEND::ADDTOLEGEND, IDLITVISLEGEND::CLEANUP
IDLITVISLEGEND::GETHITVISUALIZATION, IDLITVISLEGEND::GETPROPERTY
IDLITVISLEGEND::INIT, IDLITVISLEGEND::MOVE
IDLITVISLEGEND::ONDATACHANGEUPDATE, IDLITVISLEGEND::ONNOTIFY
IDLITVISLEGEND::ONVIEWPORTCHANGE, IDLITVISLEGEND::ONVIEWZOOM
IDLITVISLEGEND::RECOMPUTELAYOUT, IDLITVISLEGEND::REMOVE
IDLITVISLEGEND::RESTORE, IDLITVISLEGEND::SETPROPERTY
IDLITVISLEGEND::TRANSLATE, IDLITVISLEGEND::_REGISTERPROPERTIES
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
IDLitVisLegend__Define
PURPOSE:
Defines the object structure for an IDLitVisLegend object.
CALLS: ***
IDLITVISLEGEND::ADD, IDLITVISLEGEND::ADDTOLEGEND, IDLITVISLEGEND::CLEANUP
IDLITVISLEGEND::GETHITVISUALIZATION, IDLITVISLEGEND::GETPROPERTY
IDLITVISLEGEND::INIT, IDLITVISLEGEND::MOVE
IDLITVISLEGEND::ONDATACHANGEUPDATE, IDLITVISLEGEND::ONNOTIFY
IDLITVISLEGEND::ONVIEWPORTCHANGE, IDLITVISLEGEND::ONVIEWZOOM
IDLITVISLEGEND::RECOMPUTELAYOUT, IDLITVISLEGEND::REMOVE
IDLITVISLEGEND::RESTORE, IDLITVISLEGEND::SETPROPERTY
IDLITVISLEGEND::TRANSLATE, IDLITVISLEGEND::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisLegendContourItem__Define
PURPOSE:
Defines the object structure for an IDLitVisLegendContourItem object.
CALLS: ***
IDLITVISLEGENDCONTOURITEM::BUILDITEM
IDLITVISLEGENDCONTOURITEM::GETPROPERTY, IDLITVISLEGENDCONTOURITEM::INIT
IDLITVISLEGENDCONTOURITEM::ONNOTIFY
IDLITVISLEGENDCONTOURITEM::RECOMPUTELAYOUT
IDLITVISLEGENDCONTOURITEM::RESTORE, IDLITVISLEGENDCONTOURITEM::SETPROPERTY
IDLITVISLEGENDCONTOURITEM::UPDATELEVELS
IDLITVISLEGENDCONTOURITEM::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisLegendContourLevelItem::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLegendContourLevelItem::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
pro IDLitVisLegendContourLevelItem::SetProperty, $
MY_LABEL_VALUE=mylabelvalue, $
MY_LABEL_TEXT=mylabeltext, $
TEXTFORMAT=textformat, $
TEXT_DEFINEDFORMAT=textDefinedFormat, $
_EXTRA=_extra
compile_opt idl2, hidden
; Set superclass properties
self->IDLitVisLegendItem::SetProperty, $
_EXTRA=_extra
; This is needed for our IDLitVisLegendContourItem parent.
if (OBJ_VALID(self._oPolyline) && N_ELEMENTS(_extra)) then $
self._oPolyline->SetProperty, _EXTRA=_extra
;; get properties from the viscontour
self->IDLitVisLegendItem::GetProperty,VIS_TARGET=oVisTarget
oVisTarget->GetProperty, CONTOUR_LEVELS=oLevels, $
C_LABEL_OBJECTS=cLabelObjects
oLevels[self._levelIndex]->GetProperty, MY_VALUE=cvalue
IF n_elements(mylabelvalue) NE 0 THEN BEGIN
self._myLabelValue = mylabelvalue
self->SetPropertyAttribute,'MY_LABEL_TEXT', $
SENSITIVE=(mylabelvalue EQ 2)
self->SetPropertyAttribute,'TEXT_DEFINEDFORMAT', $
SENSITIVE=(mylabelvalue EQ 0)
self->SetPropertyAttribute,'TEXTFORMAT', $
SENSITIVE=((mylabelvalue EQ 0) AND $
(self._textdefinedformat EQ 1))
;; set level labels property on contour legend item
self->GetProperty, PARENT=oParent
oParent->GetProperty,LEVEL_LABELS=levLab
IF mylabelvalue NE levLab-1 THEN $
oParent->SetProperty,LEVEL_LABELS=0
CASE mylabelvalue OF
;; use value from contour level
0 : BEGIN
format = (self._textFormat EQ '' ? '(G0)' : self._textFormat)
str = STRING(cValue,FORMAT=format)
self._myLabelText = str
self._oText->SetProperty,STRING=str
END
;; use contour label
1 : BEGIN
str = ' '
IF self._levelIndex LT n_elements(cLabelObjects) THEN BEGIN
oObj = cLabelObjects[self._levelIndex]
IF obj_isa(oObj,'IDLGRTEXT') THEN $
oObj->GetProperty,STRING=str
ENDIF
self._mylabeltext = str
self._oText->SetProperty,STRING=STR
END
;; user defined text
2 : BEGIN
self._oText->SetProperty,STRING=self._mylabeltext
END
ENDCASE
self->RecomputeLayout
ENDIF
IF N_ELEMENTS(mylabeltext) NE 0 THEN BEGIN
IF mylabeltext EQ '' THEN mylabeltext=' '
self._myLabelText = mylabeltext
self._oText->SetProperty,STRING=mylabeltext
self->RecomputeLayout
ENDIF
IF N_ELEMENTS(textformat) NE 0 THEN BEGIN
;; Tricky code to verify that text formats are legal
;; or the format is a valid function name.
textFormatCheck = STRTRIM(textFormat, 2)
IF textFormatCheck NE '' THEN BEGIN
IF (STRMID(textFormatCheck, 0, 1) EQ '(') && $
(STRMID(textFormatCheck, $
STRLEN(textFormatCheck)-1, 1) EQ ')') THEN BEGIN
CATCH, err
IF (err NE 0) THEN BEGIN
CATCH, /CANCEL
ENDIF ELSE BEGIN
;; If this fails we will skip over the next line.
test = STRING(0, FORMAT=textFormatCheck)
textFormatValid = textFormatCheck
ENDELSE
ENDIF ELSE BEGIN
;; it's not a format, verify that it is a textformat function
CATCH, err
IF (err NE 0) THEN BEGIN
CATCH, /CANCEL
ENDIF ELSE BEGIN
;; If this fails we will skip over the next line.
resolve_routine, textFormatCheck, $
/IS_FUNCTION, /NO_RECOMPILE
textFormatValid = textFormatCheck
ENDELSE
ENDELSE
ENDIF
IF n_elements(textFormatValid) NE 0 THEN BEGIN
;; apply formatting to value
self._textFormat = textFormatValid
format = (self._textFormat EQ '' ? '(G0)' : self._textFormat)
str = STRING(cValue,FORMAT=format)
self._myLabelText = str
self._oText->SetProperty,STRING=str
ENDIF
self->RecomputeLayout
ENDIF
IF N_ELEMENTS(textDefinedFormat) NE 0 THEN BEGIN
self._textDefinedFormat = textDefinedFormat
self->SetPropertyAttribute,'TEXTFORMAT', $
SENSITIVE=(textDefinedFormat EQ 1)
result = IDLitGetResource(1, numericFormats, /NUMERICFORMAT, /FORMATS)
result = IDLitGetResource(1, timeFormats, /TIMEFORMAT, /FORMATS)
offset = (num = 2) ; offset to account for first two formats
CASE 1 OF
;; no format
textDefinedFormat EQ 0 : textFormat=''
;; use custom TEXTFORMAT code already in place
textDefinedFormat EQ 1 : textFormat = self._textFormat
;; numeric formats
textDefinedFormat LT ((num+=n_elements(numericFormats))) : $
textFormat = numericFormats[textDefinedFormat-offset]
;; time formats
textDefinedFormat LT ((num+=n_elements(timeFormats))) : $
textFormat = $
timeFormats[textDefinedFormat-offset-n_elements(numericFormats)]
ELSE :
ENDCASE
;; apply formatting
self._textformat=textFormat
format = (self._textFormat EQ '' ? '(G0)' : self._textFormat)
str = STRING(cValue,FORMAT=format)
self._myLabelText = str
self._oText->SetProperty,STRING=str
self->RecomputeLayout
ENDIF
end
----------------------------------------------------------------------------
+
METHODNAME:
IDLitVisLegendContourLevelItem::GetProperty
PURPOSE:
This procedure method gets the value of a property.
CALLING SEQUENCE:
Obj->[IDLitVisLegendContourLevelItem::]GetProperty
INPUTS:
NONE
KEYWORD PARAMETERS:
pro IDLitVisLegendContourLevelItem::GetProperty, $
MY_LABEL_TEXT=mylabeltext, $
MY_LABEL_VALUE=mylabelvalue, $
TEXTFORMAT=textformat, $
TEXT_DEFINEDFORMAT=textDefinedFormat, $
_REF_EXTRA=_extra
compile_opt idl2, hidden
; Get superclass properties
self->IDLitVisLegendItem::GetProperty, $
_EXTRA=_extra
IF ARG_PRESENT(mylabeltext) THEN $
mylabeltext = self._myLabelText
IF ARG_PRESENT(mylabelvalue) THEN $
mylabelvalue = self._myLabelValue
IF ARG_PRESENT(textformat) THEN $
textformat = self._textFormat
IF ARG_PRESENT(textDefinedFormat) THEN $
textDefinedFormat = self._textDefinedFormat
end
----------------------------------------------------------------------------
IIDLDataObserver Interface
----------------------------------------------------------------------------
;---------------------------------------------------------------------------
; IDLitVisLegend::OnNotify
;
;
; strItem - The item being observed
;
; strMessage - What happend. For properties this would be
; "SETPROPERTY"
;
; strUser - Message related data. For SETPROPERTY, this is the
; property that changed.
;
;
pro IDLitVisLegendContourLevelItem::OnNotify, strItem, StrMessage, strUser
compile_opt idl2, hidden
; Let superclass handle other messages.
if (strMessage ne 'SETPROPERTY') then begin
; Call our superclass.
self->IDLitVisLegendItem::OnNotify, $
strItem, StrMessage, strUser
return
endif
oTool = self->GetTool()
oSubject=oTool->GetByIdentifier(strItem)
case STRUPCASE(strUser) OF
'COLOR': begin
oSubject->GetProperty, COLOR=color
if (N_ELEMENTS(color) gt 0) then begin
self._oPolyline->SetProperty, $
COLOR=color
endif
end
'MY_LINESTYLE': BEGIN
oSubject->GetProperty, MY_LINESTYLE=linestyle
if (N_ELEMENTS(linestyle) gt 0) then begin
self._oPolyline->SetProperty, $
LINESTYLE=linestyle
endif
end
;; from contour level: none, value, text, or symbol
'MY_LABELLING' : BEGIN
oSubject->GetProperty, MY_LABELLING=labelling
IF self._mylabelvalue EQ 1 THEN BEGIN
;; set legend labels
SWITCH labelling OF
0:& 3: BEGIN
self._oText->SetProperty,STRING=' '
BREAK
END
1:& 2: BEGIN
oSubject->GetProperty, MY_LABEL_TEXT=str
IF str EQ '' THEN str=' '
self._oText->SetProperty,STRINGS=str
BREAK
END
ELSE :
ENDSWITCH
self->RecomputeLayout
ENDIF
;; set legend symbols
CASE labelling EQ 3 OF
;; no symbols on line
0 : BEGIN
IF obj_valid(self._oSymbol) THEN BEGIN
self._oSymbol->SetProperty,SYM_INDEX=0
self._oPolyline->SetProperty, $
SYMBOL=self._oSymbol->GetSymbol()
ENDIF
END
;; put symbols on line
1 : BEGIN
self->IDLitVisLegendItem::GetProperty, $
VIS_TARGET=oVisTarget
oVisTarget->GetProperty, C_LABEL_OBJECTS=cObjs
IF ~obj_valid(self._oSymbol) THEN BEGIN
IF (n_elements(cObjs) GT self._levelIndex) && $
obj_isa(cObjs[self._levelIndex],'IDLGRSYMBOL') THEN BEGIN
self._oSymbol = obj_new('IDLitSymbol', $
PARENT=self._oPolyline)
ENDIF
ENDIF
IF obj_valid(self._oSymbol) THEN BEGIN
;; get symbol properties and apply them here
oSubject->GetProperty, $
MY_LABEL_SYMBOL=symIndex, $
MY_SYMBOL_SIZE=symSize
self._oSymbol->SetProperty, $
SYM_INDEX=symIndex, $
SYM_SIZE=symSize*self._symbolScaleFactor
self._oPolyline->SetProperty, $
SYMBOL=self._oSymbol->GetSymbol()
ENDIF
END
ENDCASE
END
'MY_VALUE': BEGIN
IF self._mylabelvalue EQ 0 THEN BEGIN
oSubject->GetProperty, MY_VALUE=value
if (N_ELEMENTS(value) gt 0) then begin
format = (self._textFormat EQ '' ? '(G0)' : $
self._textFormat)
self._oText->SetProperty, $
STRINGS=STRING(value, FORMAT=format)
endif
ENDIF
END
'MY_LABEL_TEXT': BEGIN
IF self._mylabelvalue EQ 1 THEN BEGIN
oSubject->GetProperty, MY_LABELLING=labelling
SWITCH labelling OF
0:& 3: BEGIN
self._oText->SetProperty,STRING=' '
BREAK
END
1:& 2: BEGIN
oSubject->GetProperty, MY_LABEL_TEXT=str
IF str EQ '' THEN str=' '
self._oText->SetProperty,STRINGS=str
BREAK
END
ELSE :
ENDSWITCH
self->RecomputeLayout
ENDIF
END
'MY_THICK': begin
oSubject->GetProperty, MY_THICK=thick
if (N_ELEMENTS(thick) gt 0) then begin
self._oPolyline->SetProperty, $
THICK=thick
endif
end
'SYM_INDEX': begin
oSubject->GetProperty, SYM_INDEX=symIndex
if (N_ELEMENTS(symIndex) gt 0) then begin
self._oSymbol->SetProperty, $
SYM_INDEX=symIndex
endif
end
'SYM_SIZE': begin
oSubject->GetProperty, SYM_SIZE=symSize
if (N_ELEMENTS(symSize) gt 0) then begin
self._oSymbol->SetProperty, $
SYM_SIZE=symSize
endif
end
;; symbol index
'MY_LABEL_SYMBOL': BEGIN
oSubject->GetProperty, MY_LABEL_SYMBOL=symIndex
IF (N_ELEMENTS(symIndex) GT 0) THEN BEGIN
self._oSymbol->SetProperty, $
SYM_INDEX=symIndex
ENDIF
END
;; symbol size
'MY_SYMBOL_SIZE': BEGIN
oSubject->GetProperty, MY_SYMBOL_SIZE=symSize
IF (N_ELEMENTS(symSize) GT 0) THEN BEGIN
self._oSymbol->SetProperty, $
SYM_SIZE=symSize*self._symbolScaleFactor
ENDIF
END
'USE_DEFAULT_COLOR': begin
oSubject->GetProperty, USE_DEFAULT_COLOR=useDefaultColor
if (N_ELEMENTS(useDefaultColor) gt 0) then begin
self._oSymbol->SetProperty, $
USE_DEFAULT_COLOR=useDefaultColor
endif
end
'SYM_COLOR': begin
oSubject->GetProperty, SYM_COLOR=symColor
if (N_ELEMENTS(symColor) gt 0) then begin
self._oSymbol->SetProperty, $
SYM_COLOR=symColor
endif
end
'SYM_THICK': begin
oSubject->GetProperty, SYM_THICK=symThick
if (N_ELEMENTS(symThick) gt 0) then begin
self._oSymbol->SetProperty, $
SYM_THICK=symThick
endif
end
else: ; ignore unknown parameters
endcase
end
----------------------------------------------------------------------------
Object Definition
----------------------------------------------------------------------------
----------------------------------------------------------------------------
+
IDLitVisLegendContourLevelItem__Define
PURPOSE:
Defines the object structure for an IDLitVisLegendContourLevelItem object.
CALLS: ***
IDLITGETRESOURCE, IDLITVISLEGENDCONTOURLEVELITEM::BUILDITEM
IDLITVISLEGENDCONTOURLEVELITEM::CLEANUP
IDLITVISLEGENDCONTOURLEVELITEM::GETPROPERTY
IDLITVISLEGENDCONTOURLEVELITEM::INIT
IDLITVISLEGENDCONTOURLEVELITEM::ONNOTIFY
IDLITVISLEGENDCONTOURLEVELITEM::RECOMPUTELAYOUT
IDLITVISLEGENDCONTOURLEVELITEM::RESTORE
IDLITVISLEGENDCONTOURLEVELITEM::SETPROPERTY
IDLITVISLEGENDCONTOURLEVELITEM::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisLegendItem::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLegendItem::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisLegendItem::Init followed by the word "Get"
can be retrieved using IDLitVisLegendItem::GetProperty. In addition
the following keywords are available:
pro IDLitVisLegendItem::GetProperty, $
TEXT_COLOR=textColor, $
ITEM_TEXT=itemText, $
ORIENTATION=orientation, $
ITEM_RANGE=itemRange, $
VIS_TARGET=oVisTarget, $
_REF_EXTRA=_extra
compile_opt idl2, hidden
; Get my properties
if (ARG_PRESENT(itemText)) then $
self._oText->GetProperty, STRINGS=itemText
if (ARG_PRESENT(textColor)) then $
self._oText->GetProperty, COLOR=textColor
if (ARG_PRESENT(itemRange)) then begin
oTool = self->GetTool()
oWindow = oTool->GetCurrentWindow()
if (~OBJ_VALID(oWindow)) then $
return
textDimensions = oWindow->GetTextDimensions(self._oText)
itemRange = [self._sampleWidth+self._horizSpacing+textDimensions[0], $
textDimensions[1]]
endif
if (ARG_PRESENT(oVisTarget)) then $
oVisTarget = self._oVisTarget
; get superclass properties
if (N_ELEMENTS(_extra) gt 0) then $
self->IDLitVisualization::GetProperty, _EXTRA=_extra
end
----------------------------------------------------------------------------
+
METHODNAME:
IDLitVisLegendItem::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLegendItem::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisLegendItem::Init followed by the word "Set"
can be set using IDLitVisLegendItem::SetProperty.
CALLS: ***
IDLITVISLEGENDITEM::ADD, IDLITVISLEGENDITEM::BUILDITEM
IDLITVISLEGENDITEM::CLEANUP, IDLITVISLEGENDITEM::GETPROPERTY
IDLITVISLEGENDITEM::GETVIS, IDLITVISLEGENDITEM::INIT
IDLITVISLEGENDITEM::ONDATACHANGEUPDATE, IDLITVISLEGENDITEM::ONNOTIFY
IDLITVISLEGENDITEM::RESTORE, IDLITVISLEGENDITEM::SETPROPERTY
IDLITVISLEGENDITEM::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisLegendItem::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the IDLgrImage object.
CALLING SEQUENCE:
Obj->[IDLitVisLegendItem::]OnDataChangeUpdate, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the image) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
Then, it puts the data in the IDLgrImage object.
pro IDLitVisLegendItem::OnDataChangeUpdate, oSubject, parmName
compile_opt idl2, hidden
case STRUPCASE(parmName) OF
'<PARAMETER SET>':begin
;; Get our data
position = oSubject->Get(/ALL, count=nCount, NAME=names)
for i=0, nCount-1 do begin
oData = oSubject->GetByName(names[i],count=nCount)
IF nCount NE 0 THEN self->OnDataChangeUpdate,oData,names[i]
endfor
END
'VISUALIZATION': begin
success = oSubject->GetData(oVis)
if (success eq 1) then $
self->BuildItem, oVis
end
else: ; ignore unknown parameters
endcase
end
---------------------------------------------------------------------------
IDLitVisLegend::OnNotify
strItem - The item being observed
strMessage - What happend. For properties this would be
"SETPROPERTY"
strUser - Message related data. For SETPROPERTY, this is the
property that changed.
pro IDLitVisLegendItem::OnNotify, strItem, StrMessage, strUser
compile_opt idl2, hidden
case strMessage of
; Setting our hide property will also call a RecomputeLayout.
'DELETE': begin
self->GetProperty, PARENT=oLegend
if (OBJ_VALID(oLegend)) then begin
oLegend->Remove, self
oLegend->RecomputeLayout
endif
end
'UNDELETE': begin
self._oVisTarget->GetProperty, HIDE=hide
self->SetProperty, HIDE=hide
end
else: ; ignore unknown messages
endcase
end
---------------------------------------------------------------------------
function IDLitVisLegendItem::GetVis
compile_opt idl2, hidden
return, self._oVisTarget
end
----------------------------------------------------------------------------
Object Definition
----------------------------------------------------------------------------
----------------------------------------------------------------------------
+
IDLitVisLegendItem__Define
PURPOSE:
Defines the object structure for an IDLitVisLegendItem object.
CALLS: ***
IDLITVISLEGENDITEM::ADD, IDLITVISLEGENDITEM::BUILDITEM
IDLITVISLEGENDITEM::CLEANUP, IDLITVISLEGENDITEM::GETPROPERTY
IDLITVISLEGENDITEM::GETVIS, IDLITVISLEGENDITEM::INIT
IDLITVISLEGENDITEM::ONDATACHANGEUPDATE, IDLITVISLEGENDITEM::ONNOTIFY
IDLITVISLEGENDITEM::RESTORE, IDLITVISLEGENDITEM::SETPROPERTY
IDLITVISLEGENDITEM::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisLegendPlotItem__Define
PURPOSE:
Defines the object structure for an IDLitVisLegendPlotItem object.
CALLS: ***
IDLITVISLEGENDPLOTITEM::BUILDITEM, IDLITVISLEGENDPLOTITEM::INIT
IDLITVISLEGENDPLOTITEM::ONNOTIFY, IDLITVISLEGENDPLOTITEM::RECOMPUTELAYOUT
IDLITVISLEGENDPLOTITEM::RESTORE
[Previous]
[Next]
IDLitVisLegendSurfaceItem__Define
PURPOSE:
Defines the object structure for an IDLitVisLegendSurfaceItem object.
CALLS: ***
IDLITVISLEGENDSURFACEITEM::BUILDITEM, IDLITVISLEGENDSURFACEITEM::INIT
IDLITVISLEGENDSURFACEITEM::ONNOTIFY
IDLITVISLEGENDSURFACEITEM::RECOMPUTELAYOUT
[Previous]
[Next]
METHODNAME:
IDLitVisLight::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisLight')
INPUTS:
<None>
KEYWORD PARAMETERS:
All keywords accepted by IDLgrLight::Init, and:
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
METHODNAME:
IDLitVisLight::_RevolveProfile
PURPOSE:
This procedure method computes the vertices and connectivity for
a surface of revolution for the given XY profile.
CALLING SEQUENCE:
Obj->[IDLitVisLight::]_RevolveProfile, x, y, outVerts, outConn
INPUTS:
x: A vector of the x components of the profile vertices.
y: A vector of the y components of the profile vertices.
outVerts: A named variable that upon return will contain a [3,N] array
representing the vertices for the surface of revolution.
outConn: A named variable that upon return will contain the connectivity
vector for the surface of revolution.
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
METHODNAME:
IDLitVisLight::_BuildVisual
PURPOSE:
This procedure method builds a visual representation for the light
based upon its type.
CALLING SEQUENCE:
Obj->[IDLitVisLight::]_BuildVisual
INPUTS:
<None>
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
METHODNAME:
IDLitVisLight::GetProperty
PURPOSE:
This procedure method retrieves the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisLight::]GetProperty
INPUTS:
<None>
KEYWORD PARAMETERS:
Any keyword to IDLitVisLight::Init followed by the word "Get"
can be retrieved using IDLitVisLight::GetProperty.
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
METHODNAME:
IDLitVisLight::SetProperty
PURPOSE:
This procedure method sets the value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisLight::]SetProperty
INPUTS:
<None>
KEYWORD PARAMETERS:
Any keyword to IDLitVisLight::Init followed by the word "Set"
can be set using IDLitVisLight::SetProperty.
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
IDLitVisLight__Define
PURPOSE:
Defines the object structure for an IDLitVisLight object.
CALLS: ***
CROSSP, IDENTITY, IDLITVISLIGHT::CLEANUP, IDLITVISLIGHT::GETPROPERTY
IDLITVISLIGHT::INIT, IDLITVISLIGHT::RESTORE, IDLITVISLIGHT::SELECT
IDLITVISLIGHT::SETPROPERTY, IDLITVISLIGHT::TRANSLATE
IDLITVISLIGHT::UPDATESELECTIONVISUAL
IDLITVISLIGHT::UPDATESELECTIONVISUALVISIBILITY
IDLITVISLIGHT::_BUILDAMBIENT, IDLITVISLIGHT::_BUILDDIRECTIONAL
IDLITVISLIGHT::_BUILDLIGHTBULB, IDLITVISLIGHT::_BUILDSPOTLIGHT
IDLITVISLIGHT::_BUILDVISUAL, IDLITVISLIGHT::_COLORINTENSITY
IDLITVISLIGHT::_REGISTERPROPERTIES, IDLITVISLIGHT::_REVOLVEPROFILE
[Previous]
[Next]
CLASS_NAME:
IDLitVisLineProfile3D
PURPOSE:
The IDLitVisLineProfile3D class implements a a line profile visualization
object for the iTools system. This class is subclassed from
IDLitVisPolyline primarily for the purpose of trapping movement and
resizing of the line profile so that the line profile plot can be
updated to match.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPolyline
CALLS: ***
CONGRID, IDLITVISLINEPROFILE3D::CLEANUP, IDLITVISLINEPROFILE3D::CREATE3DLINE
IDLITVISLINEPROFILE3D::INIT, IDLITVISLINEPROFILE3D::MOVEVERTEX
IDLITVISLINEPROFILE3D::ONDATACHANGEUPDATE, IDLITVISLINEPROFILE3D::RESTORE
IDLITVISLINEPROFILE3D::TRANSLATE, IDLITVISLINEPROFILE3D::_CLIPANDUPDATE
INTERPOL, REVERSE, UNIQ
[Previous]
[Next]
IDLitVisLineProfile3D__Define
PURPOSE:
Defines the object structure for an IDLitVisLineProfile3D object.
NOTES:
- endpoints stores the line according to how the user defines it -
both by drawing/moving the endpoints and any translations.
This line is clipped by the dataspace range and the clipped line
is the line actually stored in the VisPolyline.
- clippingFlag prevents this object from updating _endpoints with
clipped data.
CALLS: ***
CONGRID, IDLITVISLINEPROFILE3D::CLEANUP, IDLITVISLINEPROFILE3D::CREATE3DLINE
IDLITVISLINEPROFILE3D::INIT, IDLITVISLINEPROFILE3D::MOVEVERTEX
IDLITVISLINEPROFILE3D::ONDATACHANGEUPDATE, IDLITVISLINEPROFILE3D::RESTORE
IDLITVISLINEPROFILE3D::TRANSLATE, IDLITVISLINEPROFILE3D::_CLIPANDUPDATE
INTERPOL, REVERSE, UNIQ
[Previous]
[Next]
CLASS_NAME:
IDLitVisLineProfile
PURPOSE:
The IDLitVisLineProfile class implements a a line profile visualization
object for the iTools system. This class is subclassed from
IDLitVisPolyline primarily for the purpose of trapping movement and
resizing of the line profile so that the line profile plot can be
updated to match.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPolyline
CALLS: ***
IDLITVISLINEPROFILE::ADDPLOTPROFILE, IDLITVISLINEPROFILE::ADDVERTEX
IDLITVISLINEPROFILE::CLEANUP, IDLITVISLINEPROFILE::GETPROPERTY
IDLITVISLINEPROFILE::GETVERTEX, IDLITVISLINEPROFILE::INIT
IDLITVISLINEPROFILE::MOVEVERTEX, IDLITVISLINEPROFILE::ONDATACHANGEUPDATE
IDLITVISLINEPROFILE::ONDATARANGECHANGE, IDLITVISLINEPROFILE::ONNOTIFY
IDLITVISLINEPROFILE::RESTORE, IDLITVISLINEPROFILE::SETPROPERTY
IDLITVISLINEPROFILE::TRANSLATE, IDLITVISLINEPROFILE::_CLIPANDUPDATE
IDLITVISLINEPROFILE::_CLIPLINE, IDLITVISLINEPROFILE::_ENCODE
[Previous]
[Next]
METHODNAME:
IDLitVisLineProfile::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
CALLING SEQUENCE:
Obj->[IDLitVisLineProfile::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
CALLS: ***
IDLITVISLINEPROFILE::ADDPLOTPROFILE, IDLITVISLINEPROFILE::ADDVERTEX
IDLITVISLINEPROFILE::CLEANUP, IDLITVISLINEPROFILE::GETPROPERTY
IDLITVISLINEPROFILE::GETVERTEX, IDLITVISLINEPROFILE::INIT
IDLITVISLINEPROFILE::MOVEVERTEX, IDLITVISLINEPROFILE::ONDATACHANGEUPDATE
IDLITVISLINEPROFILE::ONDATARANGECHANGE, IDLITVISLINEPROFILE::ONNOTIFY
IDLITVISLINEPROFILE::RESTORE, IDLITVISLINEPROFILE::SETPROPERTY
IDLITVISLINEPROFILE::TRANSLATE, IDLITVISLINEPROFILE::_CLIPANDUPDATE
IDLITVISLINEPROFILE::_CLIPLINE, IDLITVISLINEPROFILE::_ENCODE
[Previous]
[Next]
METHODNAME:
IDLitVisLineProfile::OnNotify
PURPOSE:
This procedure method handles notification of changes from a Subject
we have subscribed to.
In this case, we are watching the image position and pixel size so
that we can position the line profile correctly on the image.
CALLING SEQUENCE:
Obj->[IDLitVisLineProfile::]OnDataChangeUpdate, strItem, strMsg, strUser
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITVISLINEPROFILE::ADDPLOTPROFILE, IDLITVISLINEPROFILE::ADDVERTEX
IDLITVISLINEPROFILE::CLEANUP, IDLITVISLINEPROFILE::GETPROPERTY
IDLITVISLINEPROFILE::GETVERTEX, IDLITVISLINEPROFILE::INIT
IDLITVISLINEPROFILE::MOVEVERTEX, IDLITVISLINEPROFILE::ONDATACHANGEUPDATE
IDLITVISLINEPROFILE::ONDATARANGECHANGE, IDLITVISLINEPROFILE::ONNOTIFY
IDLITVISLINEPROFILE::RESTORE, IDLITVISLINEPROFILE::SETPROPERTY
IDLITVISLINEPROFILE::TRANSLATE, IDLITVISLINEPROFILE::_CLIPANDUPDATE
IDLITVISLINEPROFILE::_CLIPLINE, IDLITVISLINEPROFILE::_ENCODE
[Previous]
[Next]
IDLitVisLineProfile__Define
PURPOSE:
Defines the object structure for an IDLitVisLineProfile object.
NOTES:
- endpoints stores the line according to how the user defines it -
both by drawing/moving the endpoints and any translations.
This line is clipped by the dataspace range and the clipped line
is the line actually stored in the VisPolyline.
- clippingFlag prevents this object from updating _endpoints with
clipped data.
CALLS: ***
IDLITVISLINEPROFILE::ADDPLOTPROFILE, IDLITVISLINEPROFILE::ADDVERTEX
IDLITVISLINEPROFILE::CLEANUP, IDLITVISLINEPROFILE::GETPROPERTY
IDLITVISLINEPROFILE::GETVERTEX, IDLITVISLINEPROFILE::INIT
IDLITVISLINEPROFILE::MOVEVERTEX, IDLITVISLINEPROFILE::ONDATACHANGEUPDATE
IDLITVISLINEPROFILE::ONDATARANGECHANGE, IDLITVISLINEPROFILE::ONNOTIFY
IDLITVISLINEPROFILE::RESTORE, IDLITVISLINEPROFILE::SETPROPERTY
IDLITVISLINEPROFILE::TRANSLATE, IDLITVISLINEPROFILE::_CLIPANDUPDATE
IDLITVISLINEPROFILE::_CLIPLINE, IDLITVISLINEPROFILE::_ENCODE
[Previous]
[Next]
CLASS_NAME:
IDLitVisMapGrid
PURPOSE:
The IDLitVisMapGrid class implements a a polyline visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
CONGRID, IDLITVISMAPGRID::EDITUSERDEFPROPERTY
IDLITVISMAPGRID::GETDATASTRING, IDLITVISMAPGRID::GETPROPERTY
IDLITVISMAPGRID::INIT, IDLITVISMAPGRID::ONDATARANGECHANGE
IDLITVISMAPGRID::ONPROJECTIONCHANGE, IDLITVISMAPGRID::RESTORE
IDLITVISMAPGRID::SETPROPERTY, IDLITVISMAPGRID::_ADDLINECONTAINERS
IDLITVISMAPGRID::_COMPUTEGRIDRANGE, IDLITVISMAPGRID::_COMPUTEGRIDSPACING
IDLITVISMAPGRID::_DEGTODMS, IDLITVISMAPGRID::_GETGRIDLINES
IDLITVISMAPGRID::_REGISTERPROPERTIES, IDLITVISMAPGRID::_UPDATEGRIDLINES
[Previous]
[Next]
IDLitVisMapGrid__Define
PURPOSE:
Defines the object structure for an IDLitVisMapGrid object.
CALLS: ***
CONGRID, IDLITVISMAPGRID::EDITUSERDEFPROPERTY
IDLITVISMAPGRID::GETDATASTRING, IDLITVISMAPGRID::GETPROPERTY
IDLITVISMAPGRID::INIT, IDLITVISMAPGRID::ONDATARANGECHANGE
IDLITVISMAPGRID::ONPROJECTIONCHANGE, IDLITVISMAPGRID::RESTORE
IDLITVISMAPGRID::SETPROPERTY, IDLITVISMAPGRID::_ADDLINECONTAINERS
IDLITVISMAPGRID::_COMPUTEGRIDRANGE, IDLITVISMAPGRID::_COMPUTEGRIDSPACING
IDLITVISMAPGRID::_DEGTODMS, IDLITVISMAPGRID::_GETGRIDLINES
IDLITVISMAPGRID::_REGISTERPROPERTIES, IDLITVISMAPGRID::_UPDATEGRIDLINES
[Previous]
[Next]
CLASS_NAME:
IDLitVisMapGridline
PURPOSE:
The IDLitVisMapGridline class implements a gridline visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISMAPGRIDLINE::CLEANUP, IDLITVISMAPGRIDLINE::GETPROPERTY
IDLITVISMAPGRIDLINE::INIT, IDLITVISMAPGRIDLINE::ONPROJECTIONCHANGE
IDLITVISMAPGRIDLINE::ONVIEWPORTCHANGE, IDLITVISMAPGRIDLINE::ONVIEWZOOM
IDLITVISMAPGRIDLINE::SETPROPERTY, IDLITVISMAPGRIDLINE::_GETLABEL
[Previous]
[Next]
IDLitVisMapGridline__Define
PURPOSE:
Defines the object structure for an IDLitVisMapGridline object.
CALLS: ***
IDLITVISMAPGRIDLINE::CLEANUP, IDLITVISMAPGRIDLINE::GETPROPERTY
IDLITVISMAPGRIDLINE::INIT, IDLITVISMAPGRIDLINE::ONPROJECTIONCHANGE
IDLITVISMAPGRIDLINE::ONVIEWPORTCHANGE, IDLITVISMAPGRIDLINE::ONVIEWZOOM
IDLITVISMAPGRIDLINE::SETPROPERTY, IDLITVISMAPGRIDLINE::_GETLABEL
[Previous]
[Next]
CLASS_NAME:
IDLitVisMapProjection
PURPOSE:
The IDLitVisMapProjection class is a helper class for viz objects with
map projection data.
CALLS: ***
IDLITVISMAPPROJECTION::GETPROPERTY, IDLITVISMAPPROJECTION::INIT
IDLITVISMAPPROJECTION::SETPROPERTY
MODIFICATION HISTORY:
Written by: CT, May 2004
[Previous]
[Next]
IDLitVisMapProjection__Define
PURPOSE:
Defines the object structure for an IDLitVisMapProjection object.
CALLS: ***
IDLITVISMAPPROJECTION::GETPROPERTY, IDLITVISMAPPROJECTION::INIT
IDLITVISMAPPROJECTION::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitVisNormalizer
PURPOSE:
The IDLitVisNormalizer class is a visualization that applies (via
a transformation matrix) a normalization scale and translation.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer::Init
PURPOSE:
The IDLitVisNormalizer::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oNormalizer = OBJ_NEW('IDLitVisNormalizer')
or
Obj->[IDLitVisNormalizer::]Init
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer::Cleanup
PURPOSE:
The IDLitVisNormalizer::Cleanup procedure method preforms all cleanup
on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, oNormalizer
or
Obj->[IDLitVisNormalizer::]Cleanup
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
_IDLitVisualization::IsIsotropic
PURPOSE:
This function method returns a flag indicating whether this visualization
is isotropic.
CALLING SEQUENCE:
Result = Obj->[_IDLitVisualization::]IsIsotropic()
OUTPUTS:
This function returns a 1 if this visualization is isotropic,
or 0 otherwise.
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer::Normalize
PURPOSE:
The IDLitVisNormalizer::Normalize procedure method applies the
appropriate normalization factors based upon the XYZ range of its
contents.
CALLING SEQUENCE:
Obj->[IDLitVisNormalizer::]Normalize
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer::NormalizeToRange
PURPOSE:
The IDLitVisNormalizer::NormalizeToRange
on the object.
CALLING SEQUENCE:
Obj->[IDLitVisNormalizer::]NormalizeToRange, XRange, YRange, ZRange
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer::OnDataComplete
PURPOSE:
This procedure method handles notification that
recently changed data is ready to be flushed.
CALLING SEQUENCE:
Obj->[IDLitVisNormalizer::]OnDataComplete, oSubject
INPUTS:
oSubject: A reference to the object sending notification
of the data flush.
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisNormalizer__Define
PURPOSE:
Defines the object structure for an IDLitVisNormalizer object.
CALLS: ***
IDLITVISNORMALIZER::COMPUTE2DPADDING, IDLITVISNORMALIZER::GETPROPERTY
IDLITVISNORMALIZER::INIT, IDLITVISNORMALIZER::ISISOTROPIC
IDLITVISNORMALIZER::NORMALIZE, IDLITVISNORMALIZER::NORMALIZETORANGE
IDLITVISNORMALIZER::ONDATACOMPLETE, IDLITVISNORMALIZER::RESTORE
IDLITVISNORMALIZER::SETPROPERTY, IDLITVISNORMALIZER::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitVisNormDataSpace
PURPOSE:
The IDLitVisNormDataSpace class is a visualization that represents
a data space (of any XYZ range) that is normalized to a [-1...1] space.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisNormalizer
IDLitVisIDataSpace
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::Init
PURPOSE:
The IDLitVisNormDataSpace::Init function method initializes this
component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
oNormDataSpace = OBJ_NEW('IDLitVisNormDataSpace')
or
Obj->[IDLitVisNormDataSpace::]Init
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::SetXYZRange
PURPOSE:
The IDLitVisNormDataSpace::SetXYZRange procedure method sets
the range of the axes used in the data space
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace::]SetXYZRange, XRange, YRange, ZRange
INPUTS:
XRange: A two-element vector, [xmin, xmax], representing
the X-axis range.
YRange: A two-element vector, [ymin, ymax], representing
the Y-axis range.
ZRange: A two-element vector, [zmin, zmax], representing
the Z-axis range.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::Normalize
PURPOSE:
The IDLitVisNormDataSpace::Normalize procedure method applies the
appropriate normalization factors based upon the XYZ range of its
contents.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace::]Normalize
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::OnDimensionChange
PURPOSE:
This procedure method handles notification that the dimensionality
of a contained object has changed.
This override the _IDLitVisualization::OnDimensionChange implementation
so that the type can be changed from DATASPACE_2D to DATASPACE_3D or
vise versa.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace:]OnDimensionChange, Subject, is3D
INPUTS:
Subject: A reference to the object sending notification
of the dimensionality change.
is3D: new 3D setting of Subject.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::OnAxesRequestChange
PURPOSE:
This procedure method handles notification that the axes request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesRequestChange implementation
so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace:]OnAxesRequestChange, Subject, axesRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes request change.
axesRequest: new axes request setting of Subject.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::OnAxesStyleRequestChange
PURPOSE:
This procedure method handles notification that the axes style request
of a contained object has changed.
This override the _IDLitVisualization::OnAxesStyleRequestChange
implementation so that the request is not propagated to the parent.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace:]OnAxesStyleRequestChange, Subject,styleRequest
INPUTS:
Subject: A reference to the object sending notification
of the axes style request change.
styleRequest: new style request setting of Subject.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::GetTargetDataSpace
PURPOSE:
This function method retrieves the dataspace being normalized
within this object.
CALLING SEQUENCE:
oDataSpace = Obj->[IDLitVisNormDataSpace::]GetTargetDataSpace()
INPUTS:
None.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::GetDataSpace
PURPOSE:
This function method retrieves the dataspace associated with
this object. [Note: this implementation overrides the implementation
within the _IDLitVisualization class.]
CALLING SEQUENCE:
oDataSpace = Obj->[IDLitVisNormDataSpace::]GetDataSpace()
INPUTS:
None.
KEYWORDS:
UNNORMALIZED: Set this keyword to a non-zero value to indicate
that the returned dataspace should subclass from 'IDLitVisDataSpace'
rather than 'IDLitVisNormDataSpace'.
OUTPUTS:
This function returns a reference to the dataspace associated
with this object, or a null object reference if no dataspace
is found.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::GetDataSpaceRoot
PURPOSE:
This function method retrieves the dataspace root that contains
this dataspace.
CALLING SEQUENCE:
oDataSpaceRoot = Obj->[IDLitVisNormDataSpace::]GetDataSpaceRoot()
INPUTS:
None.
OUTPUTS:
This function returns a reference to the dataspace root associated
with this object, or a null object reference if no dataspace root
is found.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::Add
PURPOSE:
The IDLitVisNormDataSpace::Add procedure method adds
the given items to this container.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace::]Add, oObjects, _EXTRA=_extra
INPUTS:
oObjects: A reference (or array of references) to the
object(s) to be added to this normalized data space.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::Remove
PURPOSE:
The IDLitVisNormDataSpace::Remove procedure method removes
the given items from this container.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace::]Remove, oObjects, _EXTRA=_extra
INPUTS:
oObjects: A reference (or array of references) to the
object(s) to be removed from this normalized data space.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::GetXYZRange
PURPOSE:
This function method overrides the IDLgrModel::GetXYZRange function.
CALLING SEQUENCE:
Success = Obj->[IDLitVisNormDataSpace::]GetXYZRange( $
xRange, yRange, zRange [, /NO_TRANSFORM])
ARGUMENTS
xRange: Set this argument to a named variable that upon return
will contain a two-element vector, [xmin, xmax], representing the
X range of the objects that impact the ranges.
yRange: Set this argument to a named variable that upon return
will contain a two-element vector, [ymin, ymax], representing the
Y range of the objects that impact the ranges.
zRange: Set this argument to a named variable that upon return
will contain a two-element vector, [zmin, zmax], representing the
Z range of the objects that impact the ranges.
KEYWORD PARAMETERS:
NO_TRANSFORM: Set this keyword to indicate that this Visualization's
model transform should not be applied when computing the XYZ ranges.
By default, the transform is applied.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::SetAxesRequest
PURPOSE:
This procedure method marks this dataspace as either requesting
axes, or not.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataSpace::]SetAxesRequest[, axesRequest]
INPUTS:
axesRequest: A boolean indicating whether this visualization should
be marked as requesting axes. If this argument is not present, the
visualization will be marked as requesting axes.
KEYWORDS:
ALWAYS: Set this keyword to a non-zero value to indicate
that the given axes request always applies (as opposed to being
temporary).
AUTO_COMPUTE: Set this keyword to a non-zero value to
indicate that the axes request for this visualization should be
auto-computed based upon the axes requests of its contents.
This keyword is mutually exclusive of the ALWAYS keyword, and
if set, the axesRequest argument is ignored.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace::SetAxesStyleRequest
PURPOSE:
This procedure method sets the axes style request for this
dataspace.
CALLING SEQUENCE:
Obj->[IDLitVisNormDataspace:]SetAxesStyleRequest[, styleRequest]
INPUTS:
styleRequest: A scalar representing the requested axes style.
Valid values include:
-1: this visualization no longer requests a particular axes style.
0-N: this visualization requests the corresponding style supported
by the IDLitVisDataAxes class.
KEYWORDS:
NO_NOTIFY: Set this keyword to a non-zero value to indicate
that the parent should not be notified of a change in axes
style request. By default, the parent is notified.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisNormDataSpace__Define
PURPOSE:
Defines the object structure for an IDLitVisNormDataSpace object.
CALLS: ***
IDLITVISNORMDATASPACE::ADD, IDLITVISNORMDATASPACE::GETAXES
IDLITVISNORMDATASPACE::GETDATASPACE
IDLITVISNORMDATASPACE::GETDATASPACEROOT
IDLITVISNORMDATASPACE::GETTARGETDATASPACE
IDLITVISNORMDATASPACE::GETVISUALIZATIONS
IDLITVISNORMDATASPACE::GETXYZRANGE, IDLITVISNORMDATASPACE::INIT
IDLITVISNORMDATASPACE::NORMALIZE
IDLITVISNORMDATASPACE::ONAXESREQUESTCHANGE
IDLITVISNORMDATASPACE::ONAXESSTYLEREQUESTCHANGE
IDLITVISNORMDATASPACE::ONDIMENSIONCHANGE, IDLITVISNORMDATASPACE::REMOVE
IDLITVISNORMDATASPACE::REQUIRESDOUBLE
IDLITVISNORMDATASPACE::SETAXESREQUEST
IDLITVISNORMDATASPACE::SETAXESSTYLEREQUEST
IDLITVISNORMDATASPACE::SETPIXELDATASIZE
IDLITVISNORMDATASPACE::SETXYZRANGE
IDLITVISNORMDATASPACE::_CHECKDIMENSIONCHANGE
IDLITVISNORMDATASPACE::_SETTOOL, REVERSE
[Previous]
[Next]
CLASS_NAME:
IDLitVisPlot3D
PURPOSE:
The IDLitVisPlot class is the component that implements a 3D plot
using IDLgrPolyline.
CATEGORY:
Components
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
MODIFICATION HISTORY:
Written by: AY, 02/2003
[Previous]
[Next]
The IDLitVisPlot3D object implements 3D plots.
METHODNAMES:
IDLitVisPlot3D::Init
PURPOSE:
Initialize this component
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisPlot3D')
INPUTS:
KEYWORD PARAMETERS:
ERRORBAR_COLOR (Get, Set):
RGB value specifying the color for the error bar.
Default = [0,0,0] (black)
ERRORBAR_CAPSIZE (Get, Set):
Float value specifying the size of the error bar endcaps.
Value ranges from 0 to 1.0. A value of 1.0 results
in an endcap that is 10% of the width/height of the plot.
SYM_INCREMENT (Get, Set):
Integer value specifying the number of vertices to increment
between symbol instances. Default is 1 for a symbol on
every vertex.
SYM_INDEX (Get, Set) (IDLitSymbol):
The symbol index that specifies the particular symbol (or no symbol)
to use.
SYM_SIZE (Get, Set) (IDLitSymbol):
Float value from 0.0 to 1.0 specifying the size of the plot symbol.
A value of 1.0 results in an symbol that is 10% of the width/height
of the plot.
SYM_COLOR (Get, Set) (IDLitSymbol):
RGB value speciying the color for the plot symbol. Note this
color is applied to the symbol only if the USE_DEFAULT_COLOR
property is false.
SYM_THICK (Get, Set) (IDLitSymbol):
Float value from 1 to 10 specifying the thickness of the plot symbol.
TRANSPARENCY (Get, Set):
Integer value specifying the transparency of the filled area.
Valid values range from 0 to 100. Default is 0 (opaque).
USE_DEFAULT_COLOR (Get, Set) (IDLitSymbol):
Boolean: False to use the symbol color instead of matching the plot.
[XYZ]_ERRORBARS (Get, Set):
Boolean: Hide or Show the error bars. Default = Show
[XYZ]_LOG (Get, Set):
Set this keyword to specify a logarithmic axis. The minimum
value of the axis range must be greater than zero.
XY_SHADOW (Get, Set):
YZ_SHADOW (Get, Set):
XZ_SHADOW (Get, Set):
Set these keywords to display the shadow of the plot in a 3D plot.
The shadow lies in the plane specified by the first two letters of
the keyword, at the minimum value of the data
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::Cleanup
PURPOSE:
This procedure method performs all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisPlot3d::]Cleanup
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisPlot3d::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisPlot3d::Init followed by the word "Get"
can be retrieved using IDLitVisPlot3d::GetProperty.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisPlot3d::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisPlot3d::Init followed by the word "Set"
can be set using IDLitVisPlot3d::SetProperty.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::_ComputeShadowColor, color
PURPOSE:
This procedure method updates the error bar geometry based
on the plot data.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_ComputeShadowColor
INPUTS:
color: RGB color values of plot to be used to compute a
shadow color.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::_SetPolylineOneVector, dim, data
PURPOSE:
This procedure method updates the error bar geometry based
on the plot data.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_SetPolylineOneVector
INPUTS:
dim: dimension to operate on, 0 for X, 1 for Y, 2 for Z
data: data to load into the polyline
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::_UpdateShadows
PURPOSE:
Update the geometry of the plot shadows
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_UpdateShadows
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::_UpdateSymIncrement
PURPOSE:
Update the spacing of the symbols on the plot.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_UpdateSymIncrement
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::_UpdateSymSize
PURPOSE:
Update the size of the symbols on the plot.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_UpdateSymSize
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the
subject and updates the internal IDLgrPolyline object.
CALLING SEQUENCE:
Obj->[IDLitVisPlot3d::]OnDataChange, oSubject, parmName
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the plot) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
Then it puts the data in the IDLgrPolyline object.
parmName: The name of the registered parameter.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::GetSymbol
PURPOSE:
This function method returns the symbol associated with
the plot. This allows the legend to retrieve the object
reference to obtain symbol properties directly.
CALLING SEQUENCE:
oSymbol = Obj->[IDLitVisPlot3d::]GetSymbol
RETURN VALUE:
Object reference to the symbol associated with the plot.
INPUTS:
There are no inputs for this method.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
METHODNAME:
IDLitVisPlot3d::GetDataString
PURPOSE:
Convert XY dataspace coordinates into actual data values.
CALLING SEQUENCE:
strDataValue = Obj->[IDLitVisPlot3d::]GetDataString
RETURN VALUE:
String value representing the specified data values.
INPUTS:
3 element vector containing X,Y and Z data coordinates.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
IDLitVisPlot3d__Define
PURPOSE:
Defines the object structure for an IDLitVisPlot3d object.
INPUTS:
There are no inputs for this method.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITLANGCATQUERY, IDLITVISPLOT3D::CLEANUP
IDLITVISPLOT3D::EDITUSERDEFPROPERTY, IDLITVISPLOT3D::GETDATASTRING
IDLITVISPLOT3D::GETPROPERTY, IDLITVISPLOT3D::GETSYMBOL, IDLITVISPLOT3D::INIT
IDLITVISPLOT3D::ONDATACHANGEUPDATE, IDLITVISPLOT3D::ONDATADISCONNECT
IDLITVISPLOT3D::ONDATARANGECHANGE, IDLITVISPLOT3D::SETPROPERTY
IDLITVISPLOT3D::_COMPUTESHADOWCOLOR, IDLITVISPLOT3D::_REGISTERPARAMETERS
IDLITVISPLOT3D::_REGISTERPROPERTIES, IDLITVISPLOT3D::_SETPOLYLINEONEVECTOR
IDLITVISPLOT3D::_UPDATECAPSIZE, IDLITVISPLOT3D::_UPDATEERRORBARS
IDLITVISPLOT3D::_UPDATESHADOWS, IDLITVISPLOT3D::_UPDATESYMINCREMENT
IDLITVISPLOT3D::_UPDATESYMSIZE
[Previous]
[Next]
CLASS_NAME:
IDLitVisPlot
PURPOSE:
The IDLitVisPlot class is the component wrapper for IDLgrPlot
CATEGORY:
Components
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
MODIFICATION HISTORY:
Written by: AY, 02/2003
[Previous]
[Next]
Note that this discussion covers both 2D and 3D
plots. The IDLitVisplot object implements 2D plots, while the
IDLitVisPlot3D object implements 3D plots.
METHODNAMES:
IDLitVisPlot::Init
IDLitVisPlot3D::Init
PURPOSE:
Initialize this component
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisPlot', [[X,] Y]])
Obj = OBJ_NEW('IDLitVisPlot3D', X, Y, Z)
Obj = OBJ_NEW('IDLitVisPlot', Vertices2D)
Obj = OBJ_NEW('IDLitVisPlot3D', Vertices3D)
Obj = OBJ_NEW('IDLitVisPlot', [R], Theta, /POLAR)
INPUTS:
X: Vector of X coordinates
Y: Vector of Y coordinates
Z: Vector of Z coordinates
Vertices2D: 2xN array of X and Y coordinates
Vertices2D: 3xN array of X, Y and Z coordinates
R: Radius for Polar plot
Theta: Angle in radians for Polar plot
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrPlot in addition to
the following:
ERRORBAR_COLOR (Get, Set):
RGB value specifying the color for the error bar.
Default = [0,0,0] (black)
ERRORBAR_CAPSIZE (Get, Set):
Float value specifying the size of the error bar endcaps.
Value ranges from 0 to 1.0. A value of 1.0 results
in an endcap that is 10% of the width/height of the plot.
FILL_BACKGROUND (Get, Set):
Boolean: True or False fill the area under the plot.
Default = False.
FILL_COLOR (Get, Set):
RGB value specifying the color for the filled area.
Default = [255,255,255] (white)
FILL_LEVEL (Get, Set):
Float value specifying the Y value for the lower boundary
of the fill region.
HISTOGRAM (Get, Set) (IDLgrPlot)
Set this keyword to force only horizontal and vertical lines
to be used to connect the plotted points. By default, the
points are connected using a single straight line. The
histogram property applies to 2D plots only. The histogram
keyword is ignored for 3D plots.
PLOT_TRANSPARENCY (Get, Set):
Integer value specifying the transparency of the plot lines.
Valid values range from 0 to 100. Default is 0 (opaque).
POLAR (Get, Set)
Set this keyword to display the plot as a polar plot. If this is
set the arguments will be interpreted as R and Theta or simply
Theta for a single argument. If R is not supplied the plot will
use a vector of indices for the R argument. Default = False
SYM_INCREMENT (Get, Set):
Integer value specifying the number of vertices to increment
between symbol instances. Default is 1 for a symbol on
every vertex.
SYM_INDEX (Get, Set) (IDLitSymbol):
The symbol index that specifies the particular symbol (or no symbol)
to use.
SYM_SIZE (Get, Set) (IDLitSymbol):
Float value from 0.0 to 1.0 specifying the size of the plot symbol.
A value of 1.0 results in an symbol that is 10% of the width/height
of the plot.
SYM_COLOR (Get, Set) (IDLitSymbol):
RGB value speciying the color for the plot symbol. Note this
color is applied to the symbol only if the USE_DEFAULT_COLOR
property is false.
SYM_THICK (Get, Set) (IDLitSymbol):
Float value from 1 to 10 specifying the thickness of the plot symbol.
TRANSPARENCY (Get, Set):
Integer value specifying the transparency of the filled area.
Valid values range from 0 to 100. Default is 0 (opaque).
USE_DEFAULT_COLOR (Get, Set) (IDLitSymbol):
Boolean: False to use the symbol color instead of matching the plot.
[XY]_ERRORBARS (Get, Set):
Boolean: Hide or Show the error bars. Default = Show
[XY]_LOG (Get, Set):
Set this keyword to specify a logarithmic axis. The minimum
value of the axis range must be greater than zero.
XY_SHADOW (Get, Set):
YZ_SHADOW (Get, Set):
XZ_SHADOW (Get, Set):
Set these keywords to display the shadow of the plot in a 3D plot.
The shadow lies in the plane specified by the first two letters of
the keyword, at the minimum value of the data
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::Cleanup
PURPOSE:
This procedure method performs all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisPlot::]Cleanup
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisPlot::Init followed by the word "Get"
can be retrieved using IDLitVisPlot::GetProperty.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisPlot::Init followed by the word "Set"
can be set using IDLitVisPlot::SetProperty.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::_UpdateSelectionVisual
PURPOSE:
This procedure method updates the selection visual based
on the plot data.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_UpdateSelectionVisual
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::_VerifyErrorBars, dim
PURPOSE:
This procedure method creates the error bar container
and visualizations.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_VerifyErrorBars
INPUTS:
dim: 0 for X, 1 for Y
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::_UpdateFill
PURPOSE:
This procedure method updates the polygon representing
the filled area under the plot. It must be updated when
the fill level (the lower boundary) changes or when going
into or out of histogram mode, for example.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]_UpdateFill
INPUTS:
DataspaceX/Yrange: Optional args giving the dataspace ranges.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::GetSymbol
PURPOSE:
This function method returns the symbol associated with
the plot. This allows the legend to retrieve the object
reference to obtain symbol properties directly.
CALLING SEQUENCE:
oSymbol = Obj->[IDLitVisPlot::]GetSymbol
RETURN VALUE:
Object reference to the symbol associated with the plot.
INPUTS:
There are no inputs for this method.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::GetDataString
PURPOSE:
Convert XY dataspace coordinates into actual data values.
CALLING SEQUENCE:
strDataValue = Obj->[IDLitVisPlot::]GetDataString
RETURN VALUE:
String value representing the specified data values.
INPUTS:
3 element vector containing X,Y and Z data coordinates.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
METHODNAME:
IDLitVisPlot::GetHitVisualization
PURPOSE:
This procedure method overrides the default method, and
always returns the self object reference. Therefore, if
a click occurs on the filled portion, you get the plot.
CALLING SEQUENCE:
Obj->[IDLitVisPlot::]GetHitVisualization, oSubHitList
INPUTS:
oSubHitList: A reference to the object hit
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
IDLitVisPlot__Define
PURPOSE:
Defines the object structure for an IDLitVisPlot object.
INPUTS:
There are no inputs for this method.
OUTPUTS:
There are no outputs for this method.
KEYWORD PARAMETERS:
There are no keywords for this method.
CALLS: ***
IDLITVISPLOT::CLEANUP, IDLITVISPLOT::EDITUSERDEFPROPERTY
IDLITVISPLOT::GETDATASTRING, IDLITVISPLOT::GETHITVISUALIZATION
IDLITVISPLOT::GETPROPERTY, IDLITVISPLOT::GETSYMBOL, IDLITVISPLOT::INIT
IDLITVISPLOT::ONDATACHANGEUPDATE, IDLITVISPLOT::ONDATADISCONNECT
IDLITVISPLOT::ONDATARANGECHANGE, IDLITVISPLOT::RESTORE
IDLITVISPLOT::SETPROPERTY, IDLITVISPLOT::UPDATESELECTIONVISUAL
IDLITVISPLOT::_FILLCLIPX, IDLITVISPLOT::_FILLCLIPY
IDLITVISPLOT::_REGISTERPARAMETERS, IDLITVISPLOT::_REGISTERPROPERTIES
IDLITVISPLOT::_UPDATECAPSIZE, IDLITVISPLOT::_UPDATEERRORBARRANGE
IDLITVISPLOT::_UPDATEERRORBARS, IDLITVISPLOT::_UPDATEFILL
IDLITVISPLOT::_UPDATESELECTIONVISUAL, IDLITVISPLOT::_UPDATESYMINCREMENT
IDLITVISPLOT::_UPDATESYMSIZE, IDLITVISPLOT::_VERIFYERRORBARS
[Previous]
[Next]
CLASS_NAME:
IDLitVisPlotProfile
PURPOSE:
The IDLitVisPlotProfile class implements a plot profile visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPlot
CALLS: ***
IDLITVISPLOTPROFILE::CLEANUP, IDLITVISPLOTPROFILE::GETPROPERTY
IDLITVISPLOTPROFILE::INIT, IDLITVISPLOTPROFILE::ONDATACHANGEUPDATE
IDLITVISPLOTPROFILE::ONNOTIFY, IDLITVISPLOTPROFILE::SETPROPERTY
IDLITVISPLOTPROFILE::_UPDATEVIS, IDLITVISPLOTPROFILE::_UPDATEVIS3D
[Previous]
[Next]
METHODNAME:
IDLitVisPlotProfile::OnNotify
PURPOSE:
This procedure method handles notification of changes from a Subject
we have subscribed to.
In this case, we are watching the image position and pixel size so
that we can gather the correct data from the image to make the plot.
CALLING SEQUENCE:
Obj->[IDLitVisPlotProfile::]OnDataChangeUpdate, strItem, strMsg, strUser
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITVISPLOTPROFILE::CLEANUP, IDLITVISPLOTPROFILE::GETPROPERTY
IDLITVISPLOTPROFILE::INIT, IDLITVISPLOTPROFILE::ONDATACHANGEUPDATE
IDLITVISPLOTPROFILE::ONNOTIFY, IDLITVISPLOTPROFILE::SETPROPERTY
IDLITVISPLOTPROFILE::_UPDATEVIS, IDLITVISPLOTPROFILE::_UPDATEVIS3D
[Previous]
[Next]
IDLitVisPlotProfile__Define
PURPOSE:
Defines the object structure for an IDLitVisPlotProfile object.
CALLS: ***
IDLITVISPLOTPROFILE::CLEANUP, IDLITVISPLOTPROFILE::GETPROPERTY
IDLITVISPLOTPROFILE::INIT, IDLITVISPLOTPROFILE::ONDATACHANGEUPDATE
IDLITVISPLOTPROFILE::ONNOTIFY, IDLITVISPLOTPROFILE::SETPROPERTY
IDLITVISPLOTPROFILE::_UPDATEVIS, IDLITVISPLOTPROFILE::_UPDATEVIS3D
[Previous]
[Next]
CLASS_NAME:
IDLitVisPolygon
PURPOSE:
The IDLitVisPolygon class implements a a polygon visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISPOLYGON::CLEANUP, IDLITVISPOLYGON::GETLONLATRANGE
IDLITVISPOLYGON::GETPROPERTY, IDLITVISPOLYGON::INIT
IDLITVISPOLYGON::ONDATACHANGEUPDATE, IDLITVISPOLYGON::ONPROJECTIONCHANGE
IDLITVISPOLYGON::ONWORLDDIMENSIONCHANGE, IDLITVISPOLYGON::RESTORE
IDLITVISPOLYGON::SETPROPERTY, IDLITVISPOLYGON::_REGISTERPROPERTIES
IDLITVISPOLYGON::_TESSELLATESHAPES, IDLITVISPOLYGON::_UPDATEDATA
[Previous]
[Next]
METHODNAME:
IDLitVisPolygon::OnWorldDimensionChange
PURPOSE:
This procedure method handles notification that the dimensionality
of the parent world has changed.
CALLING SEQUENCE:
Obj->[IDLitVisPolygon::]OnWorldDimensionChange, Subject, is3D
INPUTS:
Subject: A reference to the object sending notification of the
dimensionality change.
is3D: new 3D setting of Subject.
CALLS: ***
IDLITVISPOLYGON::CLEANUP, IDLITVISPOLYGON::GETLONLATRANGE
IDLITVISPOLYGON::GETPROPERTY, IDLITVISPOLYGON::INIT
IDLITVISPOLYGON::ONDATACHANGEUPDATE, IDLITVISPOLYGON::ONPROJECTIONCHANGE
IDLITVISPOLYGON::ONWORLDDIMENSIONCHANGE, IDLITVISPOLYGON::RESTORE
IDLITVISPOLYGON::SETPROPERTY, IDLITVISPOLYGON::_REGISTERPROPERTIES
IDLITVISPOLYGON::_TESSELLATESHAPES, IDLITVISPOLYGON::_UPDATEDATA
[Previous]
[Next]
IDLitVisPolygon__Define
PURPOSE:
Defines the object structure for an IDLitVisPolygon object.
CALLS: ***
IDLITVISPOLYGON::CLEANUP, IDLITVISPOLYGON::GETLONLATRANGE
IDLITVISPOLYGON::GETPROPERTY, IDLITVISPOLYGON::INIT
IDLITVISPOLYGON::ONDATACHANGEUPDATE, IDLITVISPOLYGON::ONPROJECTIONCHANGE
IDLITVISPOLYGON::ONWORLDDIMENSIONCHANGE, IDLITVISPOLYGON::RESTORE
IDLITVISPOLYGON::SETPROPERTY, IDLITVISPOLYGON::_REGISTERPROPERTIES
IDLITVISPOLYGON::_TESSELLATESHAPES, IDLITVISPOLYGON::_UPDATEDATA
[Previous]
[Next]
CLASS_NAME:
IDLitVisPolyline
PURPOSE:
The IDLitVisPolyline class implements a a polyline visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
CONGRID, IDLITVISPOLYLINE::CLEANUP, IDLITVISPOLYLINE::GETLONLATRANGE
IDLITVISPOLYLINE::GETPROPERTY, IDLITVISPOLYLINE::INIT
IDLITVISPOLYLINE::ONDATACHANGEUPDATE, IDLITVISPOLYLINE::ONDATARANGECHANGE
IDLITVISPOLYLINE::ONPROJECTIONCHANGE, IDLITVISPOLYLINE::RESTORE
IDLITVISPOLYLINE::SETPROPERTY, IDLITVISPOLYLINE::_MAPINTERPOLATE
IDLITVISPOLYLINE::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisPolyline__Define
PURPOSE:
Defines the object structure for an IDLitVisPolyline object.
CALLS: ***
CONGRID, IDLITVISPOLYLINE::CLEANUP, IDLITVISPOLYLINE::GETLONLATRANGE
IDLITVISPOLYLINE::GETPROPERTY, IDLITVISPOLYLINE::INIT
IDLITVISPOLYLINE::ONDATACHANGEUPDATE, IDLITVISPOLYLINE::ONDATARANGECHANGE
IDLITVISPOLYLINE::ONPROJECTIONCHANGE, IDLITVISPOLYLINE::RESTORE
IDLITVISPOLYLINE::SETPROPERTY, IDLITVISPOLYLINE::_MAPINTERPOLATE
IDLITVISPOLYLINE::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitVisROI
PURPOSE:
The IDLitVisROI class is the component wrapper for IDLgrROI
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::Init
PURPOSE:
This function method initializes the component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisROI')
or
Obj->[IDLitVisROI::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses. In addition, the following
keywords are supported:
ROI_TYPE (Get): Set this keyword to indicate the type of the
region. Valid values include:
0 = points
1 = path
2 = closed polygon (the default)
[Note: this keyword is a wrapper for the TYPE property of
the contained IDLgrROI. The intent is to avoid any conflict
with the TYPE property of an _IDLitVisualization.]
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisROI::]Cleanup
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::GetProperty
PURPOSE:
This procedure method retrieves the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]GetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::GetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisROI::Init followed by the word "Get" can be retrieved
using IDLitVisROIn::GetProperty. In addition, the following keywords
are supported:
_VERTICES: Set this keyword to a named variable that upon return
will contain a [3,N] vector representing the vertices of the ROI
(or the scalar, -1L, if the ROI contains no vertices).
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::SetProperty
PURPOSE:
This procedure method sets the value of a property or group of
properties.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]SetProperty
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::SetProperty methods
of this object's superclasses. Furthermore, any keyword to
IDLitVisROI::Init followed by the word "Set" can be retrieved
using IDLitVisROI::SetProperty. In addition, the following keywords
are supported:
_VERTICES: Set this keyword to a [3,N] vector representing the
vertices to be associated with the ROI (or a scalar if the ROI
is to contain no vertices).
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
NOTE: This implementation currently assumes that no transformation
matrix is being applied between this ROI and the Subject sending
the notification.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::OnDataChangeUpdate
PURPOSE:
This procedure method handles notification that the data has changed.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]OnDataChangeUpdate, Subject
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::_UpdateSelectionVisual
PURPOSE:
This procedure method updates the geometry of the selection visual
to match the geometry of the ROI.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]_UpdateSelectionVisual
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::OnWorldDimensionChange
PURPOSE:
This procedure method handles notification that the dimensionality
of the parent world has changed.
CALLING SEQUENCE:
Obj->[IDLitVisROI:]OnDimensionChange, Subject, is3D
INPUTS:
Subject: A reference to the object sending notification
of the dimensionality change.
is3D: new 3D setting of Subject.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::BeginManipulation
PURPOSE:
This procedure method handles notification that a manipulator
is about to modify this ROI.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]BeginManipulator, Manipulator
INPUTS:
Manipulator: A reference to the manipulator object sending
notification.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
METHODNAME:
IDLitVisROI::EndManipulation
PURPOSE:
This procedure method handles notification that a manipulator
is finished modifying this visualization.
CALLING SEQUENCE:
Obj->[IDLitVisROI::]EndManipulator, Manipulator
INPUTS:
Manipulator: A reference to the manipulator object sending
notification.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
IDLitVisROI__Define
PURPOSE:
Defines the object structure.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
CALLED BY:
IDLitVisROIDisablePixelUpdates, IDLitVisROIEnablePixelUpdates
IDLitVisROI_UpdatePixelData
[Previous]
[Next]
Name:
IDLitVisROI::_UpdatePixelData
Purpose:
This internal procedure method updates the values within the stored
pixel data (if currently being used).
Calling Sequence:
Obj->[IDLitVisROI::]_UpdatePixelData
Keywords:
CREATE: Set this keyword to indicate that the pixel data should be
created if it does not already exist. By default, if the pixel
data does not already exist, then no action is taken.
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
idlitvisroi__define [10], idlitvisroi__define [11], idlitvisroi__define [12]
idlitvisroi__define [1], idlitvisroi__define [2], idlitvisroi__define [3]
idlitvisroi__define [4], idlitvisroi__define [5], idlitvisroi__define [6]
idlitvisroi__define [7], idlitvisroi__define [8], idlitvisroi__define [9]
[Previous]
[Next]
Name:
IDLitVisROI::DisablePixelUpdates
Purpose:
This procedure method disables that automatic computation of
ROI pixel data values whenever the ROI or target visualization
data changes.
Calling Sequence:
Obj->[IDLitVisROI::]DisablePixelUpdates
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
idlitvisroi__define [10], idlitvisroi__define [11], idlitvisroi__define [12]
idlitvisroi__define [1], idlitvisroi__define [2], idlitvisroi__define [3]
idlitvisroi__define [4], idlitvisroi__define [5], idlitvisroi__define [6]
idlitvisroi__define [7], idlitvisroi__define [8], idlitvisroi__define [9]
[Previous]
[Next]
Name:
IDLitVisROI::EnablePixelUpdates
Purpose:
This procedure method enables that automatic computation of
ROI pixel data values whenever the ROI or target visualization
data changes.
Calling Sequence:
Obj->[IDLitVisROI::]EnablePixelUpdates
CALLS: ***
IDLITVISROI::APPENDDATA, IDLITVISROI::BEGINMANIPULATION
IDLITVISROI::CLEANUP, IDLITVISROI::COMPUTEGEOMETRY, IDLITVISROI::COMPUTEMASK
IDLITVISROI::DISABLEPIXELUPDATES, IDLITVISROI::ENABLEPIXELUPDATES
IDLITVISROI::ENDMANIPULATION, IDLITVISROI::GETPIXELDATA
IDLITVISROI::GETPROPERTY, IDLITVISROI::INIT, IDLITVISROI::ONDATACHANGEUPDATE
IDLITVISROI::ONDATARANGECHANGE, IDLITVISROI::ONWORLDDIMENSIONCHANGE
IDLITVISROI::REMOVEDATA, IDLITVISROI::REPLACEDATA, IDLITVISROI::RESTORE
IDLITVISROI::SETPROPERTY, IDLITVISROI::TRANSLATE
IDLITVISROI::_REGISTERPROPERTIES, IDLITVISROI::_REPOSITIONTOGRID
IDLITVISROI::_UPDATEPIXELDATA, IDLITVISROI::_UPDATESELECTIONVISUAL
idlitvisroi__define [10], idlitvisroi__define [11], idlitvisroi__define [12]
idlitvisroi__define [1], idlitvisroi__define [2], idlitvisroi__define [3]
idlitvisroi__define [4], idlitvisroi__define [5], idlitvisroi__define [6]
idlitvisroi__define [7], idlitvisroi__define [8], idlitvisroi__define [9]
[Previous]
[Next]
CLASS_NAME:
IDLitVisShapePoint
PURPOSE:
The IDLitVisShapePoint class implements a a polyline visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISSHAPEPOINT::CLEANUP, IDLITVISSHAPEPOINT::GETPROPERTY
IDLITVISSHAPEPOINT::INIT, IDLITVISSHAPEPOINT::ONDATACHANGEUPDATE
IDLITVISSHAPEPOINT::ONDATARANGECHANGE
IDLITVISSHAPEPOINT::ONPROJECTIONCHANGE, IDLITVISSHAPEPOINT::RESTORE
IDLITVISSHAPEPOINT::SETPROPERTY, IDLITVISSHAPEPOINT::_REGISTERPROPERTIES
[Previous]
[Next]
METHODNAME:
IDLitVisImage::OnDataRangeChange
PURPOSE:
This procedure method handles notification that the data range
has changed.
CALLING SEQUENCE:
Obj->[IDLitVisImage::]OnDataRangeChange, oSubject, $
XRange, YRange, ZRange
INPUTS:
oSubject: A reference to the object sending notification
of the data range change.
XRange: The new xrange, [xmin, xmax].
YRange: The new yrange, [ymin, ymax].
ZRange: The new zrange, [zmin, zmax].
CALLS: ***
IDLITVISSHAPEPOINT::CLEANUP, IDLITVISSHAPEPOINT::GETPROPERTY
IDLITVISSHAPEPOINT::INIT, IDLITVISSHAPEPOINT::ONDATACHANGEUPDATE
IDLITVISSHAPEPOINT::ONDATARANGECHANGE
IDLITVISSHAPEPOINT::ONPROJECTIONCHANGE, IDLITVISSHAPEPOINT::RESTORE
IDLITVISSHAPEPOINT::SETPROPERTY, IDLITVISSHAPEPOINT::_REGISTERPROPERTIES
[Previous]
[Next]
IDLitVisShapePoint__Define
PURPOSE:
Defines the object structure for an IDLitVisShapePoint object.
CALLS: ***
IDLITVISSHAPEPOINT::CLEANUP, IDLITVISSHAPEPOINT::GETPROPERTY
IDLITVISSHAPEPOINT::INIT, IDLITVISSHAPEPOINT::ONDATACHANGEUPDATE
IDLITVISSHAPEPOINT::ONDATARANGECHANGE
IDLITVISSHAPEPOINT::ONPROJECTIONCHANGE, IDLITVISSHAPEPOINT::RESTORE
IDLITVISSHAPEPOINT::SETPROPERTY, IDLITVISSHAPEPOINT::_REGISTERPROPERTIES
[Previous]
[Next]
CLASS_NAME:
IDLitVisShapePolygon
PURPOSE:
The IDLitVisShapePolygon class implements a a polygon visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPolygon
CALLS: ***
IDLITVISSHAPEPOLYGON::GETPROPERTY, IDLITVISSHAPEPOLYGON::INIT
IDLITVISSHAPEPOLYGON::ONDATACHANGEUPDATE
IDLITVISSHAPEPOLYGON::SETPROPERTY
[Previous]
[Next]
CLASS_NAME:
IDLitVisShapePolyline
PURPOSE:
The IDLitVisShapePolyline class implements a a polygon visualization
object for the iTools system.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisPolygon
CALLS: ***
IDLITVISSHAPEPOLYLINE::GETPROPERTY, IDLITVISSHAPEPOLYLINE::INIT
IDLITVISSHAPEPOLYLINE::ONDATACHANGEUPDATE
IDLITVISSHAPEPOLYLINE::SETPROPERTY
[Previous]
[Next]
IDLitVisStreamline__Define
PURPOSE:
Defines the object structure for an IDLitVisStreamline object.
CALLS: ***
HIST_EQUAL, IDLITVISSTREAMLINE::CLEANUP
IDLITVISSTREAMLINE::EDITUSERDEFPROPERTY, IDLITVISSTREAMLINE::ENSUREPALETTE
IDLITVISSTREAMLINE::GETDATASTRING, IDLITVISSTREAMLINE::GETPROPERTY
IDLITVISSTREAMLINE::INIT, IDLITVISSTREAMLINE::ONDATACHANGEUPDATE
IDLITVISSTREAMLINE::ONDATADISCONNECT
IDLITVISSTREAMLINE::ONPROJECTIONCHANGE
IDLITVISSTREAMLINE::ONWORLDDIMENSIONCHANGE, IDLITVISSTREAMLINE::RESTORE
IDLITVISSTREAMLINE::SETPROPERTY, IDLITVISSTREAMLINE::_CHECKGRIDUNITS
IDLITVISSTREAMLINE::_COMPUTEDIRECTION, IDLITVISSTREAMLINE::_DEGTODMS
IDLITVISSTREAMLINE::_GETDATA, IDLITVISSTREAMLINE::_REGISTERPROPERTIES
IDLITVISSTREAMLINE::_UPDATEDATA, IDLITVISSTREAMLINE::_UPDATESTREAMLINES
[Previous]
[Next]
METHODNAME:
IDLitVisSurface::EnsureXYParameters
PURPOSE:
Ensure that X and Y parameters exist, based on the surface data
dimensions.
CALLING SEQUENCE:
Obj->[IDLitVisSurface::]EnsureXYParameters
KEYWORD PARAMETERS:
None.
USAGE:
This is used by operations such as IDLitOpInsertImage, that need
the surface parameter in order to create an image based on the
surface and to be notified of changes to the surface.
CALLS: ***
IDLITVISSURFACE::CLEANUP, IDLITVISSURFACE::DISPLAYTEXTUREMAP
IDLITVISSURFACE::DISPLAYVERTEXCOLOR, IDLITVISSURFACE::EDITUSERDEFPROPERTY
IDLITVISSURFACE::ENSUREXYPARAMETERS, IDLITVISSURFACE::GETDATASTRING
IDLITVISSURFACE::GETPROPERTY, IDLITVISSURFACE::INIT
IDLITVISSURFACE::ONDATACHANGEUPDATE, IDLITVISSURFACE::ONDATADISCONNECT
IDLITVISSURFACE::RESTORE, IDLITVISSURFACE::SETPALETTEATTRIBUTE
IDLITVISSURFACE::SETPARAMETER, IDLITVISSURFACE::SETPROPERTY
IDLITVISSURFACE::_REGISTERPROPERTIES
IDLITVISSURFACE::_VALIDATEXYPARAMETER, STRSPLIT
[Previous]
[Next]
METHODNAME:
IDLitVisSurface::SetParameter
PURPOSE;
This procedure method associates a data object with the given
parameter.
CALLING SEQUENCE:
Obj->[IDLitVisSurface::]SetParameter, ParamName, oItem
INPUTS:
ParamName: The name of the parameter to set.
oItem: The IDLitData object to be associated with the
given parameter.
CALLS: ***
IDLITVISSURFACE::CLEANUP, IDLITVISSURFACE::DISPLAYTEXTUREMAP
IDLITVISSURFACE::DISPLAYVERTEXCOLOR, IDLITVISSURFACE::EDITUSERDEFPROPERTY
IDLITVISSURFACE::ENSUREXYPARAMETERS, IDLITVISSURFACE::GETDATASTRING
IDLITVISSURFACE::GETPROPERTY, IDLITVISSURFACE::INIT
IDLITVISSURFACE::ONDATACHANGEUPDATE, IDLITVISSURFACE::ONDATADISCONNECT
IDLITVISSURFACE::RESTORE, IDLITVISSURFACE::SETPALETTEATTRIBUTE
IDLITVISSURFACE::SETPARAMETER, IDLITVISSURFACE::SETPROPERTY
IDLITVISSURFACE::_REGISTERPROPERTIES
IDLITVISSURFACE::_VALIDATEXYPARAMETER, STRSPLIT
[Previous]
[Next]
IDLitVisSurface__Define
PURPOSE:
Defines the object structure for an IDLitVisSurface object.
CALLS: ***
IDLITVISSURFACE::CLEANUP, IDLITVISSURFACE::DISPLAYTEXTUREMAP
IDLITVISSURFACE::DISPLAYVERTEXCOLOR, IDLITVISSURFACE::EDITUSERDEFPROPERTY
IDLITVISSURFACE::ENSUREXYPARAMETERS, IDLITVISSURFACE::GETDATASTRING
IDLITVISSURFACE::GETPROPERTY, IDLITVISSURFACE::INIT
IDLITVISSURFACE::ONDATACHANGEUPDATE, IDLITVISSURFACE::ONDATADISCONNECT
IDLITVISSURFACE::RESTORE, IDLITVISSURFACE::SETPALETTEATTRIBUTE
IDLITVISSURFACE::SETPARAMETER, IDLITVISSURFACE::SETPROPERTY
IDLITVISSURFACE::_REGISTERPROPERTIES
IDLITVISSURFACE::_VALIDATEXYPARAMETER, STRSPLIT
[Previous]
[Next]
CLASS_NAME:
IDLitVisText
PURPOSE:
The IDLitVisText class is the iTools implementation of a text
object.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
CALLS: ***
IDLITVISTEXT::BEGINEDITING, IDLITVISTEXT::CLEANUP, IDLITVISTEXT::ENDEDITING
IDLITVISTEXT::GETPROPERTY, IDLITVISTEXT::INIT, IDLITVISTEXT::MOVEENTRYPOINT
IDLITVISTEXT::ONDATACHANGEUPDATE, IDLITVISTEXT::ONVIEWPORTCHANGE
IDLITVISTEXT::ONVIEWZOOM, IDLITVISTEXT::SETLOCATION
IDLITVISTEXT::SETPROPERTY, IDLITVISTEXT::UPDATESELECTIONVISUAL
IDLITVISTEXT::WINDOWPOSITIONTOOFFSET, IDLITVISTEXT::_GETTEXTDIMENSIONS
[Previous]
[Next]
METHODNAME:
IDLitVisText::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisText')
INPUTS:
KEYWORD PARAMETERS:
All keywords that can be used for IDLgrFont
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
IDLITVISTEXT::BEGINEDITING, IDLITVISTEXT::CLEANUP, IDLITVISTEXT::ENDEDITING
IDLITVISTEXT::GETPROPERTY, IDLITVISTEXT::INIT, IDLITVISTEXT::MOVEENTRYPOINT
IDLITVISTEXT::ONDATACHANGEUPDATE, IDLITVISTEXT::ONVIEWPORTCHANGE
IDLITVISTEXT::ONVIEWZOOM, IDLITVISTEXT::SETLOCATION
IDLITVISTEXT::SETPROPERTY, IDLITVISTEXT::UPDATESELECTIONVISUAL
IDLITVISTEXT::WINDOWPOSITIONTOOFFSET, IDLITVISTEXT::_GETTEXTDIMENSIONS
[Previous]
[Next]
METHODNAME:
IDLitVisText::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisText::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisText::Init followed by the word "Get"
can be retrieved using IDLitVisText::GetProperty.
CALLS: ***
IDLITVISTEXT::BEGINEDITING, IDLITVISTEXT::CLEANUP, IDLITVISTEXT::ENDEDITING
IDLITVISTEXT::GETPROPERTY, IDLITVISTEXT::INIT, IDLITVISTEXT::MOVEENTRYPOINT
IDLITVISTEXT::ONDATACHANGEUPDATE, IDLITVISTEXT::ONVIEWPORTCHANGE
IDLITVISTEXT::ONVIEWZOOM, IDLITVISTEXT::SETLOCATION
IDLITVISTEXT::SETPROPERTY, IDLITVISTEXT::UPDATESELECTIONVISUAL
IDLITVISTEXT::WINDOWPOSITIONTOOFFSET, IDLITVISTEXT::_GETTEXTDIMENSIONS
[Previous]
[Next]
METHODNAME:
IDLitVisText::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisText::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisText::Init followed by the word "Set"
can be set using IDLitVisText::SetProperty.
CALLS: ***
IDLITVISTEXT::BEGINEDITING, IDLITVISTEXT::CLEANUP, IDLITVISTEXT::ENDEDITING
IDLITVISTEXT::GETPROPERTY, IDLITVISTEXT::INIT, IDLITVISTEXT::MOVEENTRYPOINT
IDLITVISTEXT::ONDATACHANGEUPDATE, IDLITVISTEXT::ONVIEWPORTCHANGE
IDLITVISTEXT::ONVIEWZOOM, IDLITVISTEXT::SETLOCATION
IDLITVISTEXT::SETPROPERTY, IDLITVISTEXT::UPDATESELECTIONVISUAL
IDLITVISTEXT::WINDOWPOSITIONTOOFFSET, IDLITVISTEXT::_GETTEXTDIMENSIONS
[Previous]
[Next]
IDLitVisText__Define
PURPOSE:
Defines the object structure for an IDLitVisText object.
CALLS: ***
IDLITVISTEXT::BEGINEDITING, IDLITVISTEXT::CLEANUP, IDLITVISTEXT::ENDEDITING
IDLITVISTEXT::GETPROPERTY, IDLITVISTEXT::INIT, IDLITVISTEXT::MOVEENTRYPOINT
IDLITVISTEXT::ONDATACHANGEUPDATE, IDLITVISTEXT::ONVIEWPORTCHANGE
IDLITVISTEXT::ONVIEWZOOM, IDLITVISTEXT::SETLOCATION
IDLITVISTEXT::SETPROPERTY, IDLITVISTEXT::UPDATESELECTIONVISUAL
IDLITVISTEXT::WINDOWPOSITIONTOOFFSET, IDLITVISTEXT::_GETTEXTDIMENSIONS
[Previous]
[Next]
CLASS_NAME:
IDLitVisualization
PURPOSE:
This class represents a collection of graphics and/or other
visualizations that as a group serve as a visual
representation for data.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
METHODNAME:
IDLitVisualization::Init
PURPOSE:
This function method initializes the component object.
NOTE: Init methods are special lifecycle methods, and as such
cannot be called outside the context of object creation. This
means that in most cases, you cannot call the Init method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Init method
from within the Init method of the subclass.
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisualization')
or
Obj->[IDLitVisualization::]Init
KEYWORD PARAMETERS:
This method accepts all keywords supported by the ::Init methods
of this object's superclasses. In addtion, the following keywords
are supported:
TOOL: Set this keyword to a reference to the IDLitTool
object with which this visualization is to be associated.
OUTPUTS:
This function returns a 1 if the initialization was successful,
or a 0 otherwise.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
METHODNAME:
IDLitVisualization::Cleanup
PURPOSE:
This procedure method preforms all cleanup on the object.
NOTE: Cleanup methods are special lifecycle methods, and as such
cannot be called outside the context of object destruction. This
means that in most cases, you cannot call the Cleanup method
directly. There is one exception to this rule: If you write
your own subclass of this class, you can call the Cleanup method
from within the Cleanup method of the subclass.
CALLING SEQUENCE:
OBJ_DESTROY, Obj
or
Obj->[IDLitVisualization::]Cleanup
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
METHODNAME:
IDLitVisualization::OnDataChange
PURPOSE:
This procedure method handles notification that the data has changed.
CALLING SEQUENCE:
Obj->[IDLitVisualization::]OnDataChange, Subject
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
METHODNAME:
IDLitVisualization::OnDataComplete
PURPOSE:
This procedure method handles notification that the data change
ins complete.
CALLING SEQUENCE:
Obj->[IDLitVisualization::]OnDataComplete, Subject
INPUTS:
Subject: A reference to the object sending notification
of the data change.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
METHODNAME:
IDLitVisualization::OnDataDelete
PURPOSE:
This procedure method handles notification that the data has been deleted
CALLING SEQUENCE:
Obj->[IDLitVisualization::]OnDataDelete, Subject
INPUTS:
Subject: A reference to the object sending notification
of the data is being deleted.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
IDLitVisualization__Define
PURPOSE:
Defines the object structure for an IDLitVisualization object.
CALLS: ***
IDLITBASENAME, IDLITLANGCATQUERY, IDLITVISUALIZATION::CLEANUP
IDLITVISUALIZATION::GETBYIDENTIFIER, IDLITVISUALIZATION::GETTYPES
IDLITVISUALIZATION::INIT, IDLITVISUALIZATION::ONDATACHANGE
IDLITVISUALIZATION::ONDATACOMPLETE, IDLITVISUALIZATION::ONDATADELETE
IDLITVISUALIZATION::ONNOTIFY, IDLITVISUALIZATION::SETDATA
IDLITVISUALIZATION::SETPARAMETERSET, IDLITVISUALIZATION::UNSETPARAMETER
[Previous]
[Next]
CLASS_NAME:
IDLitVisVolume
PURPOSE:
The IDLitVisVolume class handles rendering volume data. This class
is a "wrapper" around IDLgrVolume and renders volume data either
with the renderer in IDLgrVolume or with a "texture map stack".
Much of this class is devoted to implementing the texture map stack.
CATEGORY:
Components
SUPERCLASSES:
IDLitVisualization
SUBCLASSES:
METHODS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
MODIFICATION HISTORY:
Written by: kws
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::Init
PURPOSE:
Initialize this component
CALLING SEQUENCE:
Obj = OBJ_NEW('IDLitVisVolume')
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
This function method returns 1 on success, or 0 on failure.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::Cleanup
PURPOSE:
Cleanup this component
CALLING SEQUENCE:
OBJ_DESTROY, Obj
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_ReplicateRowsCols
PURPOSE:
Internal utility function to add a border around a texture.
The border texels are replicated from the adjacent texels.
CALLING SEQUENCE:
newTexture = self->_ReplicateRowsCols(inTexture)
INPUTS:
inTexture - 2D array
KEYWORD PARAMETERS:
OUTPUTS:
This function returns the new texture.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
The input texture memory is freed
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_BuildTexture
PURPOSE:
Internal utility function to build a texture for the
texture map volume display method.
CALLING SEQUENCE:
texture = self->_BuildTexture()
INPUTS:
vol0 - 3D array
KEYWORD PARAMETERS:
OUTPUTS:
This function returns the generated texture.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_ClearTexturePlanesVis
PURPOSE:
Internal utility function to remove the set of texture mapped polygons
for the texture planes volume display method.
This is important because the texture planes are created in a "lazy"
fashion - only when needed for drawing. If the volume data changes
(made smaller), the old planes sitting in the model can make the
volume seem too large when the range is computed for this vis.
CALLING SEQUENCE:
self->_ClearTexturePlanesVis
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_SetTexturePlanesVis
PURPOSE:
Internal utility function to build a set of texture mapped polygons
for the texture planes volume display method.
CALLING SEQUENCE:
self->_SetTexturePlanesVis
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_SetBoxVis
PURPOSE:
Internal utility function to build a semi-transparent box for a very low
quality texture map volume display method.
CALLING SEQUENCE:
self->_SetBoxVis
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::RenderVolume
PURPOSE:
Method to draw the volume with the IDLgrVolume ray-casting method once.
CALLING SEQUENCE:
self->RenderVolume()
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_RescaleVolumeData
PURPOSE:
This procedure method takes the original volume data
and recales it according to the property scale values.
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]_RescaleVolumeData
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::GetProperty
PURPOSE:
This procedure method retrieves the
value of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]GetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisVolume::Init followed by the word "Get"
can be retrieved using IDLitVisVolume::GetProperty. In addition
the following keywords are available:
ALL: Set this keyword to a named variable that will contain
an anonymous structure containing the values of all the
retrievable properties associated with this object.
NOTE: UVALUE is not returned in this struct.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::SetProperty
PURPOSE:
This procedure method sets the value
of a property or group of properties.
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]SetProperty
INPUTS:
There are no inputs for this method.
KEYWORD PARAMETERS:
Any keyword to IDLitVisVolume::Init followed by the word "Set"
can be set using IDLitVisVolume::SetProperty.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_ProcessVolumeParameters
PURPOSE:
Internal utility routine to process volume parms
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]_ProcessVolumeParameters
INPUTS:
KEYWORD PARAMETERS:
QUIET - don't throw a message. This is useful when processing
single (not in a parm set) vol parms because a series of parm
data changes may be in progress and we may be in a temporary
invalid state.
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_CreateDefaultTables
PURPOSE:
Internal utility routine to create color and opacity tables
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]_CreateDefaultTables
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::OnDataChangeUpdate
PURPOSE:
This procedure method is called by a Subject via a Notifier when
its data has changed. This method obtains the data from the subject
and updates the IDLgrVolume object.
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]OnDataChangeUpdate, oSubject
INPUTS:
oSubject: The Subject object in the Subject-Observer relationship.
This object (the volume) is the observer, so it uses the
IIDLDataSource interface to get the data from the subject.
Then, it puts the data in the IDLgrVolume object.
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::_isGrayscale
PURPOSE:
Internal utility routine to determine if a palette is greyscale
CALLING SEQUENCE:
Obj->[IDLitVisVolume::]_isGrayscale
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::Draw
PURPOSE:
Overrides the Draw method so that we can draw the volume with
either the texture map method or the IDLgrVolume volume rendering method.
CALLING SEQUENCE:
Don't call this; let the destination object (window) call it.
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
METHODNAME:
IDLitVisVolume::GetDataString
PURPOSE:
Convert XYZ dataspace coordinates into display string.
Also probe for voxel value(s) and place into string.
CALLING SEQUENCE:
Called by mouse motion manipulator
INPUTS:
3 element XYZ dataspace vector
KEYWORD PARAMETERS:
OUTPUTS:
Returns string to display
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
[Previous]
[Next]
IDLitVisVolume__Define
PURPOSE:
Defines the object structure for an IDLitVisVolume object.
CALLS: ***
CONGRID, IDLITLANGCATQUERY, IDLITVISVOLUME::CLEANUP, IDLITVISVOLUME::DRAW
IDLITVISVOLUME::EDITUSERDEFPROPERTY, IDLITVISVOLUME::GETDATASTRING
IDLITVISVOLUME::GETPROPERTY, IDLITVISVOLUME::INIT
IDLITVISVOLUME::ONDATACHANGEUPDATE, IDLITVISVOLUME::ONDATADISCONNECT
IDLITVISVOLUME::RENDERVOLUME, IDLITVISVOLUME::RESTORE
IDLITVISVOLUME::SETPROPERTY, IDLITVISVOLUME::_BUILDTEXTURE
IDLITVISVOLUME::_CLEARTEXTUREPLANESVIS
IDLITVISVOLUME::_CREATEDEFAULTTABLES, IDLITVISVOLUME::_ISGRAYSCALE
IDLITVISVOLUME::_PROCESSVOLUMEPARAMETERS
IDLITVISVOLUME::_REGISTERPROPERTIES, IDLITVISVOLUME::_REPLICATEROWSCOLS
IDLITVISVOLUME::_RESCALEVOLUMEDATA, IDLITVISVOLUME::_SETBOXVIS
IDLITVISVOLUME::_SETTEXTUREPLANESVIS, REVERSE
[Previous]
[Next]
NAME:
IDLitwdAbout
PURPOSE:
This function implements the About box
CALLING SEQUENCE:
IDLitwdAbout, wLeader
INPUTS:
wLeader - Group leader for this modal widget
OUTPUTS
None, but this is modal
RETURN VALUE
KEYWORD PARAMETERS:
Standard Widget keywords.
CALLS: ***
IDLITGETRESOURCE, IDLITLANGCATQUERY, IDLITWDABOUT_EVENT, XMANAGER
MODIFICATION HISTORY:
KDB July 02
Modified:
[Previous]
[Next]
NAME:
IDLitwdBrowser
PURPOSE:
This function implements the IT tree/property browser.
Note: This differs from the IDLitwdVizBrowser in that it doesn't
try to select the objects selected in the browser
tree. This simple widget just displays the items selected in
the property sheet, nothing else.
CALLING SEQUENCE:
IDLitwdBrowser
INPUTS:
oUI: (required) object reference for the tool user interface
KEYWORD PARAMETERS:
GROUP_LEADER: widget ID of the group leader
TITLE: string title for the top level base
VALUE: object reference of the current selected item
IDENTIFIER: string identifier of the current selected item
Note: one of VALUE or IDENTIFIER must be supplied
TREETOP: string identifier of the position in the tool tree to be
the highest visible point in the tree browser
XSIZE: xsize of the two panes
YSIZE: ysize of the two panes
NAME: (required) string name of the browser
VISIBLE: initial visibility. 1-show left panel, 2-show right
panel, 3-show both panels (default)
MULTIPLE: allow multiple selections in the tree browser
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITPROPERTYSHEET, CW_ITTREEVIEW_SETSELECT, CW_PANES [1]
CW_PANES_DRAW_SLIDER_BAR, CW_PANES_EVENT, IDLITWDBROWSER_CALLBACK
IDLITWDBROWSER_CREATEPROPSHEET, IDLITWDBROWSER_CREATETREE
IDLITWDBROWSER_EVENT, IDLITWDBROWSER_SET_EVENT, XMANAGER, cw_ittreeview
cw_panes [2]
CALLED BY:
CREATEPROPSHEET, CREATETREE, IDLITWDBROWSER_EVENT, IDLITWDBROWSER_SET_EVENT
IDLitUIBrowser, IDLitUIBrowserVis
MODIFICATION HISTORY:
Written by: CT, RSI, April 2002
Modified to use CW_PANES browser templates: AGEH, January 2003
[Previous]
[Next]
NAME:
IDLITWDBROWSER_EVENT
PURPOSE:
Event handler for the browser
INPUTS:
EVENT: (required) a widget_event structure
KEYWORD PARAMETERS:
None
OUTPUTS:
None
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITPROPERTYSHEET, CW_ITTREEVIEW_SETSELECT, CW_PANES [1]
CW_PANES_DRAW_SLIDER_BAR, CW_PANES_EVENT, IDLITWDBROWSER_CALLBACK
IDLITWDBROWSER_CREATEPROPSHEET, IDLITWDBROWSER_CREATETREE
IDLITWDBROWSER_SET_EVENT, IDLitwdBrowser, XMANAGER, cw_ittreeview, cw_panes [2]
CALLED BY:
CREATEPROPSHEET, CREATETREE, IDLITWDBROWSER_SET_EVENT, IDLitwdBrowser
[Previous]
[Next]
NAME:
IDLITWDBROWSER_SET_EVENT
PURPOSE:
Set the value of the browser
INPUTS:
ID: (required) widget ID of the top level base
VALUE: (required) integer value to be set
KEYWORD PARAMETERS:
None
OUTPUTS:
None
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITPROPERTYSHEET, CW_ITTREEVIEW_SETSELECT, CW_PANES [1]
CW_PANES_DRAW_SLIDER_BAR, CW_PANES_EVENT, IDLITWDBROWSER_CALLBACK
IDLITWDBROWSER_CREATEPROPSHEET, IDLITWDBROWSER_CREATETREE
IDLITWDBROWSER_EVENT, IDLitwdBrowser, XMANAGER, cw_ittreeview, cw_panes [2]
CALLED BY:
CREATEPROPSHEET, CREATETREE, IDLITWDBROWSER_EVENT, IDLitwdBrowser
[Previous]
[Next]
NAME:
IDLitwdBrowserPrefs
PURPOSE:
This function implements the IT tree/property browser for preferences.
CALLING SEQUENCE:
IDLitwdBrowserPrefs
INPUTS:
oUI: (required) object reference for the tool user interface
KEYWORD PARAMETERS:
GROUP_LEADER: widget ID of the group leader
TITLE: string title for the top level base
IDENTIFIER: string identifier of the tree
NAME: (required) string name of the browser
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITCOMPONENTTREE_SETROOT, CW_ITPROPERTYSHEET
IDLITLANGCATQUERY, IDLitwdBrowserPrefs_EVENT, XMANAGER
CALLED BY:
IDLitUIPrefs, IDLitwdBrowserPrefs_EVENT
MODIFICATION HISTORY:
Written by: CT, RSI, April 2002
Modified to use CW_PANES browser templates: AGEH, January 2003
Modified: CT, RSI, May 2004: Removed CW_PANES because we are modal.
[Previous]
[Next]
NAME:
IDLitwdBrowserPrefs_EVENT
PURPOSE:
Event handler for the browser
INPUTS:
EVENT: (required) a widget_event structure
KEYWORD PARAMETERS:
None
OUTPUTS:
None
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITCOMPONENTTREE_SETROOT, CW_ITPROPERTYSHEET
IDLITLANGCATQUERY, IDLitwdBrowserPrefs, XMANAGER
CALLED BY:
IDLitwdBrowserPrefs
[Previous]
[Next]
NAME:
IDLitwdCLExport
PURPOSE:
Curve fitting dialog.
CALLING SEQUENCE:
Result = IDLitwdCLExport()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDCLEXPORT_CANCEL, IDLITWDCLEXPORT_CHECKBOX
IDLITWDCLEXPORT_EVENT, IDLITWDCLEXPORT_OK, IDLITWDCLEXPORT_OUTNAME, XMANAGER
MODIFICATION HISTORY:
Written by: AGEH, RSI, January 2003
Modified:
[Previous]
[Next]
NAME:
IDLitwdConvolKernel
PURPOSE:
This function implements the convolution kernel dialog.
CALLING SEQUENCE:
IDLitwdConvolKernel
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, IDLITLANGCATQUERY, IDLITWDCONVOLKERNEL_CALLBACK
IDLITWDCONVOLKERNEL_CANCEL, IDLITWDCONVOLKERNEL_DIMENSION
IDLITWDCONVOLKERNEL_DRAW, IDLITWDCONVOLKERNEL_EVENT
IDLITWDCONVOLKERNEL_GETKERNEL, IDLITWDCONVOLKERNEL_KILLNOTIFY
IDLITWDCONVOLKERNEL_OK, IDLITWDCONVOLKERNEL_TABLE
IDLITWDCONVOLKERNEL_UPDATEDRAW, REVERSE, XMANAGER, cw_itoperationpreview
CALLED BY:
IDLitUIConvolKernel [1]
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitwdCurveFitting
PURPOSE:
Curve fitting dialog.
CALLING SEQUENCE:
Result = IDLitwdCurveFitting()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CHISQR_PDF, CW_ITUPDOWNFIELD, IDLITLANGCATQUERY, IDLITWDCURVEFITTING_CANCEL
IDLITWDCURVEFITTING_CONVERTEQN, IDLITWDCURVEFITTING_DRAW
IDLITWDCURVEFITTING_EQNDRAW, IDLITWDCURVEFITTING_EVENT
IDLITWDCURVEFITTING_MODEL, IDLITWDCURVEFITTING_OK
IDLITWDCURVEFITTING_PARAMETER, IDLITWDCURVEFITTING_REFRESH
IDLITWDCURVEFITTING_RETRIEVEPARAMS, IDLITWDCURVEFITTING_ZOOMIN
IDLITWDCURVEFITTING_ZOOMOUT, STRSPLIT, XMANAGER
CALLED BY:
IDLitUICurveFitting
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitwdDataBottomTop
PURPOSE:
This function implements the data bottom/top dialog.
CALLING SEQUENCE:
IDLitwdDataBottomTop, oUI
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDDATABOTTOMTOP_CANCEL, IDLITWDDATABOTTOMTOP_EVENT
IDLITWDDATABOTTOMTOP_OK, XMANAGER, cw_itMultiDataLevel
CALLED BY:
IDLitUIDataBottomTop
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitwdGridWizard
PURPOSE:
This function implements the Grid Wizard dialog.
CALLING SEQUENCE:
Result = IDLitwdGridWizard()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
DIALOG_WIZARD, IDLITLANGCATQUERY, IDLITWDGRIDWIZARD_1_CREATE
IDLITWDGRIDWIZARD_1_DESTROY, IDLITWDGRIDWIZARD_1_DOCREATE
IDLITWDGRIDWIZARD_2_CREATE, IDLITWDGRIDWIZARD_2_DESTROY
IDLITWDGRIDWIZARD_2_DOCREATE, IDLITWDGRIDWIZARD_3_CREATE
IDLITWDGRIDWIZARD_3_DESTROY, IDLITWDGRIDWIZARD_3_DOCREATE
IDLITWDGRIDWIZARD_ANISOELLIPSE, IDLITWDGRIDWIZARD_AUTOPREVIEW
IDLITWDGRIDWIZARD_CHECKVALUE, IDLITWDGRIDWIZARD_CREATEOBJECTS
IDLITWDGRIDWIZARD_DRAWEVENT, IDLITWDGRIDWIZARD_DRAWREFRESH
IDLITWDGRIDWIZARD_DRAWSETUP, IDLITWDGRIDWIZARD_DRAW_CONTOURS
IDLITWDGRIDWIZARD_DRAW_ELLIPSE, IDLITWDGRIDWIZARD_ELLIPSE
IDLITWDGRIDWIZARD_EMPTY_SECTORS, IDLITWDGRIDWIZARD_GRIDDATA
IDLITWDGRIDWIZARD_HELP, IDLITWDGRIDWIZARD_METHOD, IDLITWDGRIDWIZARD_NSECTORS
IDLITWDGRIDWIZARD_PREVIEW, IDLITWDGRIDWIZARD_RADIANS
IDLITWDGRIDWIZARD_SEARCHELLIPSE, IDLITWDGRIDWIZARD_SECTOR
IDLITWDGRIDWIZARD_SHOWPOINTS, IDLITWDGRIDWIZARD_SPHERE
IDLITWDGRIDWIZARD_UPDATE_OPTIONS, IDLITWDGRIDWIZARD_UPDATE_STATS, ITGW_PRINT
MOMENT
CALLED BY:
IDLitUIGridWizard
MODIFICATION HISTORY:
Written by: CT, RSI, September 2002.
Modified:
[Previous]
[Next]
NAME:
IDLitwdImgMenu
PURPOSE:
This function creates the control panel that appears in image tool.
CALLS: ***
CW_ITTOOLBAR, IDLITLANGCATQUERY, IDLITWDIMGMENU_CALLBACK, IDLITWDIMGMENU_EVENT
IDLITWDIMGMENU_GETIMAGETARGETS, IDLITWDIMGMENU_PARSEPIXELSTRING
IDLITWDIMGMENU_UPDATEIMAGE, IDLITWDIMGMENU_UPDATEOBSERVETARGETS
IDLITWDIMGMENU_UPDATEPIXELSCALE, cw_itMultiDataLevel
[Previous]
[Next]
NAME:
IDLitwdImportWizard
PURPOSE:
This function implements the import wizard, allowing the creation
of a visualization from either a file or the IDL command line.
CALLING SEQUENCE:
Result = IDLitwdImportWizard()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITCOMPONENTTREE, CW_ITPROPERTYSHEET, DIALOG_WIZARD, DIALOG_WIZARD_SETNEXT
FILEPATH, IDLITLANGCATQUERY, IDLITWDIMPORTWIZARD_1_CREATE
IDLITWDIMPORTWIZARD_1_DESTROY, IDLITWDIMPORTWIZARD_2_CREATE
IDLITWDIMPORTWIZARD_2_DESTROY, IDLITWDIMPORTWIZARD_3_CREATE
IDLITWDIMPORTWIZARD_3_DESTROY, STRSPLIT, _IDLITIW_CHECKFILENAME
_IDLITWDIW_COMMANDLINE, _IDLITWDIW_COMMANDLINE_CLEANUP
_IDLITWDIW_COMMANDLINE_EV, _IDLITWDIW_FILESEL, _IDLITWDIW_FILESEL_CLEANUP
_IDLITWDIW_FILESEL_EV, _IDLITWDIW_HELP, _IDLITWDIW_PAGE3_EV
CALLED BY:
IDLitUIImportWizard
MODIFICATION HISTORY:
Written by: CT, RSI, September 2002.
Modified:
[Previous]
[Next]
NAME:
IDLitwdIsovalues
PURPOSE:
This function implements the widget dialog for allowing the user
to select isovalues associated with a volume. These isovalues
are then used, for example, to create or modify isosurfaces.
CALLING SEQUENCE:
IDLitwdIsovalues, oUI
INPUTS:
KEYWORD PARAMETERS:
OVOLVIS - an IDLitVisVolume object
CALLS: ***
IDLITLANGCATQUERY, IDLITWDISOVALUES_CANCEL, IDLITWDISOVALUES_EVENT
IDLITWDISOVALUES_OK, XMANAGER, cw_itMultiDataLevel
CALLED BY:
IDLitUIIntVol, IDLitUIIsoSurface
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitwdMacroEditor
PURPOSE:
This function implements the iTools Macro editor.
CALLING SEQUENCE:
IDLitwdMacroEditor
INPUTS:
oUI: (required) object reference for the tool user interface
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, CW_ITTREEVIEW_ADDLEVEL, CW_ITTREEVIEW_GETSELECT
CW_ITTREEVIEW_SETSELECT, FILEPATH, IDLITBASENAME, IDLITLANGCATQUERY
IDLITWDMACROEDITOR_BUTTONEVENT, IDLITWDMACROEDITOR_CALLBACK
IDLITWDMACROEDITOR_CANCEL, IDLITWDMACROEDITOR_CLOSE, IDLITWDMACROEDITOR_COPY
IDLITWDMACROEDITOR_ENABLETREE, IDLITWDMACROEDITOR_EVENT
IDLITWDMACROEDITOR_KILLNOTIFY, IDLITWDMACROEDITOR_PASTE
IDLITWDMACROEDITOR_REMOVEPROPERTIES, IDLITWDMACROEDITOR_SAVE
IDLITWDMACROEDITOR_SETCHANGED, XMANAGER, cw_ittreeview
CALLED BY:
IDLitUIMacroEditor
MODIFICATION HISTORY:
Written by: CT, RSI, Oct 2003
[Previous]
[Next]
NAME:
IDLitwdMapPanel
PURPOSE:
This function creates the control panel that appears in the iMap tool.
CALLS: ***
IDLITLANGCATQUERY, IDLITWDMAPPANEL_CALLBACK, IDLITWDMAPPANEL_EVENT
IDLITWDMAPPANEL_KILLNOTIFY, IDLITWDMAPPANEL_OBSERVEPROJECTION
[Previous]
[Next]
NAME:
IDLitwdMapRegisterImage
PURPOSE:
This function implements the Grid Wizard dialog.
CALLING SEQUENCE:
Result = IDLitwdMapRegisterImage()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_BGROUP, CW_ITPROPERTYSHEET, DIALOG_WIZARD, DIALOG_WIZARD_SETNEXT
DIALOG_WIZARD_SETSCREENS, IDLITGETRESOURCE, IDLITLANGCATQUERY
IDLITWDMAPREGISTERIMAGE_1_CREATE, IDLITWDMAPREGISTERIMAGE_1_DESTROY
IDLITWDMAPREGISTERIMAGE_1_DOCREATE, IDLITWDMAPREGISTERIMAGE_2_CREATE
IDLITWDMAPREGISTERIMAGE_2_DESTROY, IDLITWDMAPREGISTERIMAGE_2_DOCREATE
IDLITWDMAPREGISTERIMAGE_3_CREATE, IDLITWDMAPREGISTERIMAGE_3_DESTROY
IDLITWDMAPREGISTERIMAGE_3_DOCREATE, IDLITWDMAPREGISTERIMAGE_CALLBACK
IDLITWDMAPREGISTERIMAGE_EVENT1, IDLITWDMAPREGISTERIMAGE_GEOTIFF
IDLITWDMAPREGISTERIMAGE_HELP, cw_itpropertypreview
CALLED BY:
IDLitUIConvolKernel [2]
MODIFICATION HISTORY:
Written by: CT, RSI, September 2002.
Modified:
[Previous]
[Next]
NAME:
IDLitwdOperationPreview
PURPOSE:
This function implements a simple property sheet dialog
CALLING SEQUENCE:
IDLitwdOperationPreview
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, IDLITLANGCATQUERY, IDLITWDOPERATIONPREVIEW_EVENT, XMANAGER
cw_itoperationpreview
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitwdPaletteEditor
PURPOSE:
This function implements the Palette Editor dialog.
CALLING SEQUENCE:
IDLitwdPaletteEditor, oUI
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_PALETTE_EDITOR, IDLITLANGCATQUERY, IDLITWDPALETTEEDITOR_CANCEL
IDLITWDPALETTEEDITOR_EVENT, IDLITWDPALETTEEDITOR_OK, XMANAGER
CALLED BY:
IDLitUIPaletteEditor
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitwdProgressBar
PURPOSE:
This function implements the Progress Bar.
CALLING SEQUENCE:
IDLitwdProgressBar
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDPROGRESSBAR_SETVALUE
CALLED BY:
IDLitUIProgressBar
MODIFICATION HISTORY:
Written by: CT, RSI, August 2002
Modified:
[Previous]
[Next]
NAME:
IDLitwdPromptText
PURPOSE:
Creates a modal dialog that prompts the user for a line of text.
CALLING SEQUENCE:
status = IDLitwdPromptText(otarget, wLeader, strVars)
INPUTS:
oTarget - Target operation object.
wLeader - Group leader for this modal widget
OUTPUTS
RETURN VALUE
1 - Success
0 - Cancel
KEYWORD PARAMETERS:
Standard Widget keywords.
CALLS: ***
IDLITLANGCATQUERY, IDLITWDPROMPTTEXT_EVENT, XMANAGER
CALLED BY:
IDLitUIPromptUserText
MODIFICATION HISTORY:
KDB July 02
Modified:
[Previous]
[Next]
NAME:
IDLitwdPropertyPreview
PURPOSE:
This function implements a simple property sheet dialog
CALLING SEQUENCE:
IDLitwdPropertyPreview
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, IDLITLANGCATQUERY, IDLITWDPROPERTYPREVIEW_EVENT, XMANAGER
cw_itpropertypreview
CALLED BY:
IDLituiMapProjection
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitwdPropertySheet
PURPOSE:
This function implements a simple property sheet dialog
CALLING SEQUENCE:
IDLitwdPropertySheet
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, IDLITLANGCATQUERY, IDLITWDPROPERTYSHEET_CALLBACK
IDLITWDPROPERTYSHEET_EVENT, IDLITWDPROPERTYSHEET_KILLNOTIFY, XMANAGER
CALLED BY:
IDLitUIContourLevels, IDLituiMapGridLines
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IDLitwdRotateByAngle
PURPOSE:
Curve fitting dialog.
CALLING SEQUENCE:
Result = IDLitwdRotateByAngle()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_ITUPDOWNFIELD, IDLITLANGCATQUERY, IDLITWDROTATEBYANGLE_ANGLE
IDLITWDROTATEBYANGLE_CANCEL, IDLITWDROTATEBYANGLE_DRAW
IDLITWDROTATEBYANGLE_EVENT, IDLITWDROTATEBYANGLE_OK
IDLITWDROTATEBYANGLE_UPDATE, XMANAGER
CALLED BY:
IDLituiRotateByAngle
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003
Modified:
[Previous]
[Next]
NAME:
IDLitwdStyleApply
PURPOSE:
This function implements an Apply Style dialog
CALLING SEQUENCE:
IDLitwdStyleApply
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDSTYLEAPPLY_EVENT, XMANAGER
CALLED BY:
IDLituiStyleApply
MODIFICATION HISTORY:
Written by: CT, RSI, Dec 2003
Modified:
[Previous]
[Next]
NAME:
IDLitwdStyleCreate
PURPOSE:
This function implements a simple text dialog.
CALLING SEQUENCE:
IDLitwdStyleCreate
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDSTYLECREATE_EVENT, IDLITWDSTYLECREATE_OKAY, XMANAGER
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2004
Modified:
[Previous]
[Next]
NAME:
IDLitwdStyleEditor
PURPOSE:
This function implements the iTools Style/Macro editor.
CALLING SEQUENCE:
IDLitwdStyleEditor
INPUTS:
oUI: (required) object reference for the tool user interface
KEYWORD PARAMETERS:
CALLS: ***
CW_ITPROPERTYSHEET, CW_ITPROPERTYSHEET_EVENT, CW_ITTREEVIEW_ADDLEVEL
CW_ITTREEVIEW_EVENT, CW_ITTREEVIEW_SETSELECT, CW_PANES [1]
CW_PANES_DRAW_SLIDER_BAR, CW_PANES_EVENT, IDLITBASENAME, IDLITLANGCATQUERY
IDLITWDSTYLEEDITOR_BUTTONEVENT, IDLITWDSTYLEEDITOR_CALLBACK
IDLITWDSTYLEEDITOR_CANCEL, IDLITWDSTYLEEDITOR_CLOSE
IDLITWDSTYLEEDITOR_COPYPROP, IDLITWDSTYLEEDITOR_COPYTREE
IDLITWDSTYLEEDITOR_CREATEPROPSHEET, IDLITWDSTYLEEDITOR_CREATETREEVIEW
IDLITWDSTYLEEDITOR_DELETEPROP, IDLITWDSTYLEEDITOR_ENABLEPROP
IDLITWDSTYLEEDITOR_ENABLETREE, IDLITWDSTYLEEDITOR_EVENT
IDLITWDSTYLEEDITOR_ISSTYLE, IDLITWDSTYLEEDITOR_KILLNOTIFY
IDLITWDSTYLEEDITOR_LEFTEVENT, IDLITWDSTYLEEDITOR_PASTE
IDLITWDSTYLEEDITOR_RIGHTEVENT, IDLITWDSTYLEEDITOR_SAVE
IDLITWDSTYLEEDITOR_SETCHANGED, XMANAGER, cw_ittreeview, cw_panes [2]
CALLED BY:
IDLitUIStyleEditor
MODIFICATION HISTORY:
Written by: CT, RSI, Oct 2003
[Previous]
[Next]
NAME:
IDLitwdSubVolume
PURPOSE:
This function implements the widget dialog for allowing the user
to select a subvolume rendering range for a volume.
CALLING SEQUENCE:
IDLitwdSubVolume, oUI
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDSUBVOLUME_CANCEL, IDLITWDSUBVOLUME_EVENT
IDLITWDSUBVOLUME_OK, XMANAGER, cw_itDataLevel
CALLED BY:
IDLitUISubVolume
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IDLitwdTextdisplay
PURPOSE:
This procedure displays text in a text widget.
CALLING SEQUENCE:
IDLitwdTextdisplay, Text
INPUTS:
Text: Set this argument to a string array containing the text
to display.
KEYWORD PARAMETERS:
GROUP_LEADER:
TITLE:
CALLS: ***
IDLITLANGCATQUERY, IDLITWDTEXTDISPLAY_CLOSE, IDLITWDTEXTDISPLAY_EDITTEXT
IDLITWDTEXTDISPLAY_EVENT, IDLITWDTEXTDISPLAY_KILLNOTIFY
IDLITWDTEXTDISPLAY_PRINT, IDLITWDTEXTDISPLAY_SAVEAS, XMANAGER
CALLED BY:
IDLituiTextDisplay
MODIFICATION HISTORY:
Written by: CT, RSI, September 2002
Modified:
[Previous]
[Next]
NAME:
IDLitwdTool
PURPOSE:
Create the IDL UI (widget) interface for an associated tool object.
CALLING SEQUENCE:
IDLitwdTool, Tool
INPUTS:
Tool - Object reference to the tool object.
CALLS: ***
CW_ITPANEL, CW_ITPANEL_RESIZE, CW_ITSTATUSBAR_RESIZE, CW_ITTOOLBAR, CW_ITWINDOW
CW_ITWINDOW_RESIZE, IDLITLANGCATQUERY, IDLITWDSPLASH, IDLITWDTOOL_CALLBACK
IDLITWDTOOL_CLEANUP, IDLITWDTOOL_EVENT, IDLITWDTOOL_RESIZE, STRSPLIT, XMANAGER
cw_itStatusBar, cw_itmenu, get_screen_size
[Previous]
[Next]
NAME:
IDLitwdToolbar
PURPOSE:
This function implements a floating IT toolbar.
CALLING SEQUENCE:
IDLitwdToolbar, Tool
INPUTS:
Tool: Set this argument to the object reference for the IDL Tool.
KEYWORD PARAMETERS:
CALLS: ***
CW_ITTOOLBAR, IDLITLANGCATQUERY, IDLITWDTOOLBAR_CALLBACK, IDLITWDTOOLBAR_EVENT
IDLitwdToolbar_Destroy, XMANAGER
CALLED BY:
IDLitwdToolbar_Destroy
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
; IDLitwdToolbar_callback
;
; Purpose:
; Callback routine for the tool interface widget, allowing it to
; receive update messages from the system.
;
; Parameters:
; wBase - Base id of this widget
;
; strID - ID of the message.
;
; MessageIn - What is the message
;
; userdata - Data associated with the message
CALLS: ***
CW_ITTOOLBAR, IDLITLANGCATQUERY, IDLITWDTOOLBAR_CALLBACK, IDLITWDTOOLBAR_EVENT
IDLitwdToolbar_Destroy, XMANAGER
CALLED BY:
IDLitwdToolbar_Destroy
[Previous]
[Next]
NAME:
IDLitwdToolbar_Destroy
PURPOSE:
This procedure destroys the identified toolbar.
CALLING SEQUENCE:
IDLitwdToolbar_Destroy, oUI, identifier
INPUTS:
oUI: A reference to the user interface object.
identifier: A string representing the (relative) identifier of the
toolbar to be destroyed.
CALLS: ***
CW_ITTOOLBAR, IDLITLANGCATQUERY, IDLITWDTOOLBAR_CALLBACK, IDLITWDTOOLBAR_EVENT
IDLitwdToolbar [1], XMANAGER, idlitwdtoolbar [2]
CALLED BY:
IDLitwdToolbar [1], idlitwdtoolbar [2]
[Previous]
[Next]
NAME:
IDLitWdToolSplash
PURPOSE:
Create the IDL UI (widget) splash screen. This can only be run
once per session
CALLING SEQUENCE:
IDLitWDSplash - to display
IDLitWDSplash_shutdown - to remove
KEYWORD PARAMETERS:
DELAY_TIMER
Set to the number of seconds to set the shutdown timer. This is a
fallback timer to remove the screen if other methods fail. The
default value is 10.
CALLS: ***
FILEPATH, IDLITLANGCATQUERY, IDLITWDSPLASH, IDLITWDSPLASH_EVENT
IDLITWDSPLASH_SHUTDOWN, IDLITWDSPLASH_UPDATE, XMANAGER
MODIFICATION HISTORY:
[Previous]
[Next]
NAME:
IDLitwdUnknownData
PURPOSE:
This function implements the Unknown Data dialog.
CALLING SEQUENCE:
Result = IDLitwdUnknownData()
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
DIALOG_WIZARD, IDLITGETRESOURCE, IDLITLANGCATQUERY
IDLITWDUNKNOWNDATA_1_CREATE, IDLITWDUNKNOWNDATA_1_DESTROY
IDLITWDUNKNOWNDATA_HELP, IDLITWDUNKNOWNDATA_METHOD
CALLED BY:
IDLituiUnknownData
MODIFICATION HISTORY:
Written by: CT, RSI, Jan 2003.
Modified:
[Previous]
[Next]
NAME:
IDLitwdVolMenu
PURPOSE:
This function creates the Volume Rendering control panel that
appears in volume tool.
The event handler for the menu appears here also.
CALLING SEQUENCE:
IDLitwdVolMenu
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
CW_BGROUP, IDLITLANGCATQUERY, IDLITWDVOLMENU_CALLBACK, IDLITWDVOLMENU_EVENT
IDLITWDVOLMENU_UPDATEMENU
MODIFICATION HISTORY:
Written by:
Modified:
[Previous]
[Next]
NAME:
IGAMMA
PURPOSE:
This function computes the incomplete gamma function, Px(a).
CATEGORY:
Special Functions.
CALLING SEQUENCE:
Result = Igamma(a, x)
INPUTS:
A: A scalar or array of any basic type that
specifies the parametric exponent of the integrand.
A may be complex.
X: A scalar or array of any basic type that
specifies the upper limit of integration.
X may be complex.
Note: For X < 0 you should convert X to complex first,
otherwise the Result will be 0.
KEYWORD PARAMETERS:
DOUBLE = Set this keyword to return a double-precision result.
EPS = relative accuracy, or tolerance. The default tolerance
is 3.0d-12.
ITER = Set this keyword equal to a named variable that will contain
the actual number of iterations performed.
ITMAX = Set this keyword to specify the maximum number of iterations.
The default value is 100000.
METHOD: Use this keyword to specify a named variable which returns
the method used to compute the incomplete gamma function.
A value of 0 indicates that a power series representation
was used. A value of 1 indicates that a continued fractions
method was used.
This keyword is obsolete and will return 0.
CALLED BY:
CHISQR_PDF, LINFIT
EXAMPLE:
Compute the incomplete gamma function for the corresponding elements
of A and X.
Define the parametric exponents.
A = [0.10, 0.50, 1.00, 1.10, 6.00, 26.00]
Define the the upper limits of integration.
X = [0.0316228, 0.0707107, 5.00000, 1.04881, 2.44949, 25.4951]
Compute the incomplete gamma functions.
result = Igamma(A, X)
The result should be:
[0.742026, 0.293128, 0.993262, 0.607646, 0.0387318, 0.486387]
PROCEDURE:
IGAMMA computes the incomplete gamma function, Px(a), using either
a power series representation or a continued fractions method. If X
is less than or equal to A+1, the power series representation is used.
If X is greater than A+1, the continued fractions method is used.
REFERENCE:
Numerical Recipes, The Art of Scientific Computing (Second Edition)
Cambridge University Press
ISBN 0-521-43108-5
MODIFICATION HISTORY:
Written by: GGS, RSI, September 1994
IGAMMA is based on the routines: gser.c, gcf.c, and
gammln.c described in section 6.2 of Numerical Recipes,
The Art of Scientific Computing (Second Edition), and is
used by permission.
Modified: GGS, RSI, January 1996
Corrected the case of IGAMMA(a, 0) for a > 0.
DMS, Sept, 1999, Added arrays, and more accurate
results for double.
CT, RSI, March 2000, added DOUBLE, ITER keywords.
CT, RSI, Dec 2001: Convert to internal C code, added complex support.
Remove restriction on A>0.
Made METHOD keyword obsolete.
[Previous]
[Next]
NAME:
iImage
PURPOSE:
Implements the iimage wrapper interface for the tools sytem.
CALLING SEQUENCE:
iImage[, Image][,X, Y]
INPUTS:
Image - Either a vector, two-dimensional array, or
three-dimensional array representing the sample values to be
displayed as an image.
If Image is a vector:
The X and Y arguments must also be present and contain the same
number of elements. In this case, a dialog will be presented that
offers the option of gridding the data to a regular grid (the
results of which will be displayed as a color-indexed image).
If Image is a two-dimensional array:
If either dimension is 3:
Image represents an array of XYZ values (either:
[[x0,y0,z0],[x1,y1,z1],.], or [[x0,x1,.],[y0,y1,.],[z0,z1,.]]).
In this case, the X and Y arguments, if present, will be ignored.
A dialog will be presented that allows the option of gridding the
data to a regular grid (the results of which will be displayed as
a color-indexed image, using the Z values as the image data
values).
If neither dimension is 3:
If X and Y are provided, the sample values are defined as a
function of the corresponding (X, Y) locations; otherwise, the
sample values are implicitly treated as a function of the array
indices of each element of Image.
If Image is a three-dimensional array:
If one of the dimensions is 3:
Image is an array (3xMxN, or Mx3xN, or MxNx3) representing the
red, green, and blue channels of the RGB image to be displayed.
If one of the dimensions is 4:
Image is an array (4xMxN, or Mx4xN, or MxNx4) representing the
red, green, blue, and alpha channels of the RGBA image to be
displayed.
X - Either a vector or a two-dimensional array representing the
X coordinates of the image grid.
If the Image argument is a vector:
X must be a vector with the same number of elements.
If the Image argument is a two-dimensional array (for which neither
dimension is 3):
If X is a vector, each element of X specifies the X coordinates for
a column of Image (e.g., X[0] specifies the X coordinate for
Image[0, *]).
If X is a two-dimensional array, each element of X specifies the
X coordinate of the corresponding point in Image (Xij specifies the
X coordinate of Imageij).
Y - Either a vector or a two-dimensional array representing the
Y coordinates of the image grid.
If the Image argument is a vector:
Y must be a vector with the same number of elements.
If the Image argument is a two-dimensional array:
If Y is a vector, each element of Y specifies the Y coordinates for
a column of Image (e.g., Y[0] specifies the Y coordinate for
Image[*,0]).
If Y is a two-dimensional array, each element of Y specifies the Y
coordinate of the corresponding point in Image (Yij specifies the
Y coordinate of Imageij).
KEYWORD PARAMETERS:
ALPHA_CHANNEL - Set this keyword to a two-dimensional array
representing the alpha channel pixel values for the image to
be displayed. This keyword is ignored if the Image argument is
present, and is intended to be used in conjunction with some
combination of the RED_CHANNEL, GREEN_CHANNEL, and BLUE_CHANNEL
keywords.
BLUE_CHANNEL - Set this keyword to a two-dimensional array
representing the blue channel pixel values for the image to
be displayed. This keyword is ignored if the Image argument is
present, and is intended to be used in conjunction with some
combination of the ALPHA_CHANNEL, RED_CHANNEL, and GREEN_CHANNEL
keywords.
GREEN_CHANNEL - Set this keyword to a two-dimensional array
representing the green channel pixel values for the image to
be displayed. This keyword is ignored if the Image argument is
present, and is intended to be used in conjunction with some
combination of the ALPHA_CHANNEL, RED_CHANNEL, and BLUE_CHANNEL
keywords.
IDENTIFIER [out] - The identifier of the created tool.
IMAGE_LOCATION - Set this keyword to a two-element vector, [x,y],
specifying the location of the lower-left corner of the image
in data units. The default is [0,0].
IMAGE_DIMENSIONS - Set this keyword to a two-element vector,
[width,height], specifying the dimensions of the image in
data units. The default is the pixel dimensions of the image.
RED_CHANNEL - Set this keyword to a two-dimensional array
representing the red channel pixel values for the image to be
displayed. This keyword is ignored if the Image argument is
present, and is intended to be used in conjunction with some
combination of the ALPHA_CHANNEL, GREEN_CHANNEL, and BLUE_CHANNEL
keywords.
RGB_TABLE - Set this keyword to a 3x256 or 256x3 byte array of
RGB color values to be used as the color lookup table for the
image. If no color table is supplied, iImage will provide a
default linear grayscale color lookup table for indexed images.
All other keywords are passed to the tool during creation.
CALLS: ***
IDLitsys_CreateTool, MOMENT, _CREATEIMAGEFROMCHANNELS, _SETPALETTE
_TESTREGULARGRID
CALLED BY:
iMap [1]
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified:
[Previous]
[Next]
NAME:
IMAGE_CONT
PURPOSE:
Overlay an image and a contour plot.
CATEGORY:
General graphics.
CALLING SEQUENCE:
IMAGE_CONT, A
INPUTS:
A: The two-dimensional array to display.
KEYWORD PARAMETERS:
WINDOW_SCALE: Set this keyword to scale the window size to the image size.
Otherwise, the image size is scaled to the window size.
This keyword is ignored when outputting to devices with
scalable pixels (e.g., PostScript).
ASPECT: Set this keyword to retain the image's aspect ratio.
Square pixels are assumed. If WINDOW_SCALE is set, the
aspect ratio is automatically retained.
INTERP: If this keyword is set, bilinear interpolation is used if
the image is resized.
OUTPUTS:
No explicit outputs.
COMMON BLOCKS:
None.
SIDE EFFECTS:
The currently selected display is affected.
RESTRICTIONS:
None.
PROCEDURE:
If the device has scalable pixels, then the image is written over
the plot window.
MODIFICATION HISTORY:
DMS, May, 1988.
[Previous]
[Next]
NAME:
iMap
PURPOSE:
Implements the iMap wrapper interface for the tools sytem.
CALLING SEQUENCE:
iMap[, Image][, X, Y]
or
iMap[, Z] [, X, Y], /CONTOUR
INPUTS:
See iImage for a description of the Image, X, Y arguments.
If /CONTOUR is set see iContour for a description of
the Z, X, Y arguments.
KEYWORD PARAMETERS:
CONTOUR: Set this keyword to create a Contour visualization from
the supplied data. By default, an Image visualization is created.
See iImage and iContour for list of available keywords.
CALLS: ***
iContour, iImage
MODIFICATION HISTORY:
Written by: CT, RSI, Feb 2004
Modified:
[Previous]
[Next]
NAME:
iMap
PURPOSE:
Implements the iVector wrapper interface for the tools sytem.
CALLING SEQUENCE:
iVector[, U, V][, X, Y]
INPUTS:
KEYWORD PARAMETERS:
CALLS: ***
IDLitsys_CreateTool, IVECTOR
MODIFICATION HISTORY:
Written by: CT, RSI, Oct 2005
Modified:
[Previous]
[Next]
NAME:
IMPORT_ASCII
PURPOSE:
This routine is a macro allowing the user to read in an ASCII
file and have the contents placed in the current scope as a
structure variable.
CATEGORY:
Input/Output
CALLING SEQUENCE:
IMPORT_ASCII
OUTPUTS:
This procedure creates a structure variable and places it in the current
scope. The variable is named 'filename_ascii' where filename is the main
part of the file's name not using the extension.
CALLS: ***
ASCII_TEMPLATE, IMPORT_CREATE_VARNAME, READ_ASCII
EXAMPLE:
IMPORT_ASCII
MODIFICATION HISTORY:
Written by: Scott Lasica, July, 1999
Modified: CT, RSI, July 2000: moved varName out to IMPORT_CREATE_VARNAME
[Previous]
[Next]
NAME:
IMPORT_BINARY
PURPOSE:
This routine is a macro allowing the user to read in a binary
file and have the contents placed in the current scope as a
structure variable.
CATEGORY:
Input/Output
CALLING SEQUENCE:
IMPORT_BINARY
OUTPUTS:
This procedure creates a structure variable and places it in the current
scope. The variable is named 'filename_binary' where filename is the main
part of the file's name not using the extension.
CALLS: ***
BINARY_TEMPLATE, IMPORT_CREATE_VARNAME, READ_BINARY
EXAMPLE:
IMPORT_BINARY
MODIFICATION HISTORY:
Written by: Scott Lasica, July, 1999
Modified: CT, RSI, July 2000: moved varName out to IMPORT_CREATE_VARNAME
[Previous]
[Next]
NAME:
IMPORT_CREATE_VARNAME
PURPOSE:
This routine takes a string file name and constructs a valid
variable name. For use with the IMPORT_ routines.
CATEGORY:
Input/Output
CALLING SEQUENCE:
IMPORT_CREATE_VARNAME, Name [, Path [, Suffix]]
OUTPUTS:
A string with a valid variable name.
ARGUMENTS:
Name = A string containing the file name, possibly including a file path.
Path = A string containing the file path to be removed from Name.
The default is '' (Null string).
Suffix = A string containing a suffix to be appended onto the variable
name. The default is '' (Null string).
CALLED BY:
IMPORT_ASCII, IMPORT_BINARY, IMPORT_HDF, IMPORT_IMAGE
MODIFICATION HISTORY:
Written by: CT, RSI, July, 2000
[Previous]
[Next]
NAME:
IMPORT_HDF
PURPOSE:
This routine is a macro allowing the user to read in an HDF/EOS
file and have the contents placed in the current scope as a
structure variable.
CATEGORY:
Input/Output
CALLING SEQUENCE:
IMPORT_HDF
OUTPUTS:
This procedure creates a structure variable and places it in the current
scope. The variable is named 'filename_df' where filename is the main
part of the file's name not using the extension.
CALLS: ***
HDF_READ, IMPORT_CREATE_VARNAME, IS_HDF
EXAMPLE:
IMPORT_HDF
MODIFICATION HISTORY:
Written by: Scott Lasica, July, 1999
Modified: CT, RSI, July 2000: moved varName out to IMPORT_CREATE_VARNAME
[Previous]
[Next]
NAME:
IMPORT_IMAGE
PURPOSE:
This routine is a macro allowing the user to read in an image
file and have the contents placed in the current scope as a
structure variable.
CATEGORY:
Input/Output
CALLING SEQUENCE:
IMPORT_IMAGE
OUTPUTS:
This procedure creates a structure variable and places it in the current
scope. The variable is named 'filename_image' where filename is the main
part of the file's name not using the extension.
CALLS: ***
DIALOG_READ_IMAGE, IMPORT_CREATE_VARNAME
EXAMPLE:
IMPORT_IMAGE
MODIFICATION HISTORY:
Written by: Scott Lasica, July, 1999
Modified: CT, RSI, July 2000: moved varName out to IMPORT_CREATE_VARNAME
[Previous]
[Next]
NAME:
INT_2D
PURPOSE:
This function computes the double integral of a bivariate
function F(x,y) using either a dy-dx or dx-dy order of integration.
CATEGORY:
Numerical Analysis.
CALLING SEQUENCE:
Result = INT_2D(Fxy, AB_Limits, PQ_Limits, Pts)
INPUTS:
Fxy: A scalar string specifying the name of a user-supplied
IDL function that defines the bivariate function to be
integrated. The function must accept x & y and return
a scalar result.
AB_Limits: A two-element vector containing the lower, A, and
upper, B, limits of integration. These limits correspond
to x when using a dy-dx order of integration or they
correspond to y when using a dx-dy order of integration.
PQ_Limits: A scalar string specifying the name of a user-supplied
IDL function that defines the lower, P, and upper, Q,
limits of integration. These limits correspond to y when
using a dy-dx order of integration or they correspond to
x when using a dx-dy order of integration. They must
accept x (for a dy-dx order of integration) or y (for a
dx-dy order of integration) and return a two-element
vector result.
Pts: The number of transformation points used in the
computation. Possible values are: 6, 10, 20, 48 or 96.
KEYWORD PARAMETERS:
DOUBLE: If set to a non-zero value, computations are done in
double precision arithmetic.
ORDER: A scalar value of either 0 or 1. If set to 0, the integral
is computed using a dy-dx order of integration. If set to 1,
the integral is computed using a dx-dy order of integration.
EXAMPLE:
Compute the double integral of the bivariate function
F(x, y) = y * cos(x^5) over the region: [0.0, x^2] for y and
[0.0, 2.0] for x using
a dy-dx order of integration.
;Define the Fxy function.
function Fxy, x, y
return, y*cos(x^5)
end
;Define the limits of integration for y as a function of x.
function PQ_Limits, x
return, [0.0, x^2]
end
;Define the limits of integration for x.
AB_Limits = [0.0, 2.0]
;Integrate with 48 and 96 point formulas using a dy-dx order of
;integration and double-precision arithmetic.
print, INT_2D('Fxy', AB_Limits, 'PQ_Limits', 48, /double)
print, INT_2D('Fxy', AB_Limits, 'PQ_Limits', 96, /double)
INT_2D with 48 transformation points yields: 0.055142668
INT_2D with 96 transformation points yields: 0.055142668
Compute the double integral of the bivariate function
F(x, y) = y * cos(x^5) over the equivalent region using a dx-dy order
of integration.
;Define the limits of integration for x as a function of y.
function PQ_Limits, y
return, [sqrt(y), 2.0]
end
;Define the limits of integration for y.
AB_Limits = [0.0, 4.0]
;Integrate with 48 and 96 point formulas using a dx-dy order of
;integration and double-precision arithmetic.
print, INT_2D('Fxy', AB_Limits, 'PQ_Limits', 48, /double, /order)
print, INT_2D('Fxy', AB_Limits, 'PQ_Limits', 96, /double, /order)
INT_2D with 48 transformation points yields: 0.055142678
INT_2D with 96 transformation points yields: 0.055142668
The exact solution (9 decimal accuracy) yields: 0.055142668
PROCEDURE:
INT_2D.PRO computes the double integral of a bivariate function
using iterated Gaussian Quadrature. The algorithm's transformation
data is provided in tabulated form with 15 decimal accuracy.
REFERENCE:
Handbook of Mathematical Functions
U.S. Department of Commerce
Applied Mathematics Series 55
MODIFICATION HISTORY:
Written by: GGS, RSI, January 1994
Modified: GGS, RSI, September 1994
Added 96 point transformation data.
Added DOUBLE keyword. Replaced nested FOR loop with
vector operations resulting in faster execution.
Modified: GGS, RSI, June 1995
Added ORDER keyword allowing a dx-dy order of integration.
Modified: GGS, RSI, April 1996
Modified keyword checking and use of double precision.
[Previous]
[Next]
NAME:
INT_3D
PURPOSE:
This function computes the triple integral of a trivariate
function F(x,y,z) with limits of integration from A to B
for X, from P(x) to Q(x) for Y and from U(x,y) to V(x,y)
for Z.
CATEGORY:
Numerical Analysis.
CALLING SEQUENCE:
Result = INT_3D(Fxyz, AB_Limits, PQ_Limits, UV_Limits, Pts)
INPUTS:
Fxyz: A scalar string specifying the name of a user-supplied
IDL function that defines the trivariate function to be
integrated. The function must accept x, y & z and return
a scalar result.
AB_Limits: A two-element vector containing the lower, A, and
upper, B, limits of integration for x.
PQ_Limits: A scalar string specifying the name of a user-
supplied IDL function that defines the lower, P(x),
and upper, Q(x), limits of integration for y. The
function must accept x and return a two-element
vector result.
UV_Limits: A scalar string specifying the name of a user-
supplied IDL function that defines the lower, U(x,y),
and upper, V(x,y), limits of integration for z. The
function must accept x & y and return a two-element
vector result.
Pts: The number of transformation points used in the
computation. Possible values are: 6, 10, 20, 48 or 96.
KEYWORD PARAMETERS:
DOUBLE: If set to a non-zero value, computations are done in
double precision arithmetic.
EXAMPLE:
Compute the triple integral of the trivariate function
F(x,y,z) = z * (x^2 + y^2 + z^2)^1.5 over the region:
A = -2, B = 2, Px = -sqrt(4 - x^2), Qx = sqrt(4 - x^2),
Uxy = 0, Vxy = sqrt(4 - x^2 - y^2).
;Define the trivariate function.
function Fxyz, x, y, z
return, z * (x^2 + y^2 + z^2)^1.5
end
;Define the limits of integration for y.
function PQ_Limits, x
return, [-sqrt(4. - x^2), sqrt(4. - x^2)]
end
;Define the limits of integration for z.
function UV_Limits, x, y
return, [0.0, sqrt(4. - x^2 - y^2)]
end
;Define the limits of integration for x.
AB_Limits = [-2.0, 2.0]
;Integrate with 10, 20, 48, and 96 point formulas using double-
;precision arithmetic. Notice that it is possible to abbreviate
;keywords.
print, INT_3D('Fxyz', AB_Limits, 'PQ_Limits', 'UV_Limits', 10, /d)
print, INT_3D('Fxyz', AB_Limits, 'PQ_Limits', 'UV_Limits', 20, /d)
print, INT_3D('Fxyz', AB_Limits, 'PQ_Limits', 'UV_Limits', 48, /d)
print, INT_3D('Fxyz', AB_Limits, 'PQ_Limits', 'UV_Limits', 96, /d)
INT_3D with 10 transformation points yields: 57.444248
INT_3D with 20 transformation points yields: 57.446201
INT_3D with 48 transformation points yields: 57.446265
INT_3D with 96 transformation points yields: 57.446266
The exact solution (6 decimal accuracy) yields: 57.446267
PROCEDURE:
INT_3D.PRO computes the triple integral of a trivariate function
using iterated Gaussian Quadrature. The algorithm's transformation
data is provided in tabulated form with 15 decimal accuracy.
REFERENCE:
Handbook of Mathematical Functions
U.S. Department of Commerce
Applied Mathematics Series 55
MODIFICATION HISTORY:
Written by: GGS, RSI, January 1994
Modified: GGS, RSI, September 1994
Added 96 point transformation data.
Added DOUBLE keyword. Replaced nested FOR loop with
vector operations resulting in faster execution.
Modified: GGS, RSI, April 1996
Modified keyword checking and use of double precision.
[Previous]
[Next]
NAME:
INT_TABULATED
PURPOSE:
This function integrates a tabulated set of data { x(i) , f(i) },
on the closed interval [min(X) , max(X)].
CATEGORY:
Numerical Analysis.
CALLING SEQUENCE:
Result = INT_TABULATED(X, F)
INPUTS:
X: The tabulated X-value data. This data may be irregularly
gridded and in random order. If the data is randomly ordered
you must set the SORT keyword to a nonzero value.
Duplicate x values will result in a warning message.
F: The tabulated F-value data. Upon input to the function
X(i) and F(i) must have corresponding indices for all
values of i. If X is reordered, F is also reordered.
X and F must be of floating point or double precision type.
KEYWORD PARAMETERS:
SORT: A zero or non-zero scalar value.
SORT = 0 (the default) The tabulated x-value data is
already in ascending order.
SORT = 1 The tabulated x-value data is in random order
and requires sorting into ascending order. Both
input parameters X and F are returned sorted.
DOUBLE: If set to a non-zero value, computations are done in
double precision arithmetic.
OUTPUTS:
This fuction returns the integral of F computed from the tabulated
data in the closed interval [min(X) , max(X)].
CALLS: ***
UNIQ
CALLED BY:
CRVLENGTH
RESTRICTIONS:
Data that is highly oscillatory requires a sufficient number
of samples for an accurate integral approximation.
PROCEDURE:
INT_TABULATED.PRO constructs a regularly gridded x-axis with a
number of segments as an integer multiple of four. Segments
are processed in groups of four using a 5-point Newton-Cotes
integration formula.
For 'sufficiently sampled' data, this algorithm is highly accurate.
EXAMPLES:
Example 1:
Define 11 x-values on the closed interval [0.0 , 0.8].
x = [0.0, .12, .22, .32, .36, .40, .44, .54, .64, .70, .80]
Define 11 f-values corresponding to x(i).
f = [0.200000, 1.30973, 1.30524, 1.74339, 2.07490, 2.45600, $
2.84299, 3.50730, 3.18194, 2.36302, 0.231964]
Compute the integral.
result = INT_TABULATED(x, f)
In this example, the f-values are generated from a known function,
(f = .2 + 25*x - 200*x^2 + 675*x^3 - 900*x^4 + 400*x^5)
The Multiple Application Trapazoid Method yields; result = 1.5648
The Multiple Application Simpson's Method yields; result = 1.6036
INT_TABULATED.PRO yields; result = 1.6232
The Exact Solution (4 decimal accuracy) yields; result = 1.6405
Example 2:
Create 30 random points in the closed interval [-2 , 1].
x = randomu(seed, 30) * 3.0 - 2.0
Explicitly define the interval's endpoints.
x(0) = -2.0 & x(29) = 1.0
Generate f(i) corresponding to x(i) from a given function.
f = sin(2*x) * exp(cos(2*x))
Call INT_TABULATED with the SORT keyword.
result = INT_TABULATED(x, f, /sort)
In this example, the f-values are generated from the function,
f = sin(2*x) * exp(cos(2*x))
The result of this example will vary because the x(i) are random.
Executing this example three times gave the following results:
INT_TABULATED.PRO yields; result = -0.0702
INT_TABULATED.PRO yields; result = -0.0731
INT_TABULATED.PRO yields; result = -0.0698
The Exact Solution (4 decimal accuracy) yields; result = -0.0697
MODIFICATION HISTORY:
Written by: GGS, RSI, September 1993
Modified: GGS, RSI, November 1993
Use Numerical Recipes cubic spline interpolation
function NR_SPLINE/NR_SPLINT. Execution time is
greatly reduced. Added DOUBLE keyword. The 'sigma'
keyword is no longer supported.
Modified: GGS, RSI, April 1995
Changed cubic spline calls from NR_SPLINE/NR_SPLINT
to SPL_INIT/SPL_INTERP. Improved double-precision
accuracy.
Modified: GGS, RSI, April 1996
Replaced WHILE loop with vector operations.
Check for duplicate points in x vector.
Modified keyword checking and use of double precision.
[Previous]
[Next]
NAME:
INT_TABULATED_2D
PURPOSE:
Integrate the volume formed by a surface defined by tabulated
data, (x[i], y[i], f[i]), and the XY plane, over the area
defined by the convex hull of the set of points (x,y).
CATEGORY:
Numerical Analysis.
CALLING SEQUENCE:
Result = INT_TABULATED_2D(X, Y, F)
INPUTS:
X: The array of tabulated X-value data. This data may be
irregularly gridded and in random order.
Y: The tabulated Y-value data, Y[i] corresponds to X[i].
F: The tabulated F-value data. F[i] is the function's value
at the point (X[i],Y[i]).;
X Y, and F must be of floating point or double precision type.
OUTPUTS:
This fuction returns the integral of F computed from the tabulated
data over the convex hull defined by the points in (X,Y).
Linear interpolation is used.
PROCEDURE:
The (X,Y) points are triangulated using TRIANGULATE. Then for
each triangle, in the convex hull, formed by points X[[i,j,k]]
and Y[[i,j,k]], the volume of the triangular cylinder formed
by the 6 points:
(X[i], Y[i], Z[i]), (X[j], Y[j], Z[j]), (X[i], Y[k], Z[k]),
(X[i], Y[i], 0), (X[j], Y[j], 0), and (X[k], Y[k], 0), is
computed and summed.
CALLS: ***
TETRAVOLUME
EXAMPLE:
Compute the volume between the surface f=x^2+y^2 and the XY
plane, over the interval of x=-1 to +1, y=-1 to 1, with a grid
increment of 0.1:
n = 21
x = (findgen(n) * (2./(n-1)) - 1.0) # replicate(1.0, n)
y = transpose(x)
f = x^2 + y^2
print, int_tabulated_2d(x,y,f)
2.68000
(The correct answer computed symbolically is 8/3 = 2.66667)
MODIFICATION HISTORY:
DMS, August, 1998.
[Previous]
[Next]
NAME:
INTERPOL
PURPOSE:
Linearly interpolate vectors with a regular or irregular grid.
Quadratic or a 4 point least-square fit to a quadratic
interpolation may be used as an option.
CATEGORY:
E1 - Interpolation
CALLING SEQUENCE:
Result = INTERPOL(V, N) ;For regular grids.
Result = INTERPOL(V, X, U) ;For irregular grids.
INPUTS:
V: The input vector can be any type except string.
For regular grids:
N: The number of points in the result when both input and
output grids are regular.
Irregular grids:
X: The absicissae values for V. This vector must have same # of
elements as V. The values MUST be monotonically ascending
or descending.
U: The absicissae values for the result. The result will have
the same number of elements as U. U does not need to be
monotonic. If U is outside the range of X, then the
closest two endpoints of (X,V) are linearly extrapolated.
Keyword Input Parameters:
LSQUADRATIC = if set, interpolate using a least squares
quadratic fit to the equation y = a + bx + cx^2, for each 4
point neighborhood (x[i-1], x[i], x[i+1], x[i+2]) surrounding
the interval, x[i] <= u < x[i+1].
QUADRATIC = if set, interpolate by fitting a quadratic
y = a + bx + cx^2, to the three point neighborhood (x[i-1],
x[i], x[i+1]) surrounding the interval x[i] <= u < x[i+1].
SPLINE = if set, interpolate by fitting a cubic spline to the
4 point neighborhood (x[i-1], x[i], x[i+1], x[i+2]) surrounding
the interval, x[i] <= u < x[i+1].
Note: if LSQUADRATIC or QUADRATIC or SPLINE is not set, the
default linear interpolation is used.
OUTPUTS:
INTERPOL returns a floating-point vector of N points determined
by interpolating the input vector by the specified method.
If the input vector is double or complex, the result is double
or complex.
CALLS: ***
LS2FIT
CALLED BY:
idlitvislineprofile3d__define [1], idlitvislineprofile3d__define [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
None.
PROCEDURE:
For linear interpolation,
Result(i) = V(x) + (x - FIX(x)) * (V(x+1) - V(x))
where x = i*(m-1)/(N-1) for regular grids.
m = # of elements in V, i=0 to N-1.
For irregular grids, x = U(i).
m = number of points of input vector.
For QUADRATIC interpolation, the equation y=a+bx+cx^2 is
solved explicitly for each three point interval, and is then
evaluated at the interpolate.
For LSQUADRATIC interpolation, the coefficients a, b, and c,
from the above equation are found, for the four point
interval surrounding the interpolate using a least square
fit. Then the equation is evaluated at the interpolate.
For SPLINE interpolation, a cubic spline is fit over the 4
point interval surrounding each interpolate, using the routine
SPL_INTERP().
MODIFICATION HISTORY:
Written, DMS, October, 1982.
Modified, Rob at NCAR, February, 1991. Made larger arrays possible
and correct by using long indexes into the array instead of
integers.
Modified, DMS, August, 1998. Now use binary intervals which
speed things up considerably when U is random.
DMS, May, 1999. Use new VALUE_LOCATE function to find intervals,
which speeds things up by a factor of around 100, when
interpolating from large arrays. Also added SPLINE,
QUADRATIC, and LSQUADRATIC keywords.
[Previous]
[Next]
NAME:
IPLOT
PURPOSE:
Fire up the plot iTool.
CALLING SEQUENCE:
IPLOT, [[x],y] (for 2D plot)
OR
IPLOT, x,y,z (for 3D plot)
INPUTS:
KEYWORD PARAMETERS:
SCATTER
Set this keyword to generate a scatter plot. This is equivalent
to setting LINESTYLE=6 (no line) and SYM_INDEX=3 (Period symbol).
[XYZ]ERROR
Set this keyword to either a vector or a 2xN array of error
values to be displayed as error bars for the [XYZ] dimension
of the plot. The length of this array must be equal in length
to the number of vertices of the plot or it will be ignored.
If the value is a vector, the value will be applied as both a
negative and positive error and the error bar will be symmetric
about the plot vertex. If the value is a 2xN array the [0,*]
values define the negative error and the [1,*] values define
the positive error, allowing asymmetric error bars.;
RGB_TABLE
Set this keyword to either a 3x256 or 256x3 array containing
color values to use for vertex colors. Use the VERT_COLORS
keyword to specify indices that select colors from the values
specified with RGB_TABLE.
VERT_COLORS
Set this keyword to a vector of indices into the color table
to select colors to use for vertex colors or a 3xN or 4xN array of
colors values to use directly. If the number of indices or
colors is less than the number of vertices, the colors are
repeated cyclically.
CALLS: ***
IDLitsys_CreateTool
CALLED BY:
XROI
MODIFICATION HISTORY:
Written by: CT, RSI, March 2002
Modified: AY, RSI, February 2003: Update to allow 3D data
[Previous]
[Next]
NAME:
IR_FILTER
PURPOSE:
This function filters data with an infinite impulse response (IIR)
or finite impulse response (FIR) filter. If D is a scalar then
the filter is IIR, otherwise it is FIR.
CATEGORY:
Signal processing.
CALLING SEQUENCE:
Y = IR_FILTER(C [, D], X)
PARAMETERS:
C - A vector defining the numerator coefficients.
D - A vector defining the scaling factor and denominator
coefficients.
X - Input data vector.
KEYWORDS:
DOUBLE - If set, return Y as double, default is float.
CALLS: ***
REVERSE
MODIFICATION HISTORY:
Created by: AGEH, December 2005
[Previous]
[Next]
NAME:
iSurface
PURPOSE:
Implements the isurface wrapper interface for the tools sytem.
CALLING SEQUENCE:
ISurface
INPUTS:
Z[,X,Y] [,...] (see IDLgrSurface)
KEYWORD PARAMETERS:
IDENTIFIER [out] - The identifier of the created tool.
VERT_COLORS: vector or 2D array of color indices,
or a two-dimensional array containing RGB triplets or RGBA values.
TEXTURE_IMAGE: 2D array (MxN), 3D array (3xMxN, Mx3xN, MxNx3,
4xMxN, Mx4xN, MxNx4) RGB with optional alpha channel
TEXTURE_RED, TEXTURE_GREEN, TEXTURE_BLUE, TEXTURE_ALPHA: 2D arrays
(must be of same size and type) specifying, respectively, red
channel, green channel, blue channel, and, optionally, the alpha
channel of the image to be used as the TEXTURE_IMAGE
RGB_TABLE: 2D array (3x256) specifying the colors to be used when
index color is used
All other keywords are passed to the tool during creation.
CALLS: ***
IDLitsys_CreateTool, _IDLitsys_GetSystem
MODIFICATION HISTORY:
Written by: AGEH, RSI, January 2003
Modified:
[Previous]
[Next]
NAME:
itCurrent
PURPOSE:
Used to set the current tool in the iTools system.
CALLING SEQUENCE:
itCurrent, idTool
INPUTS:
idTool - The identifier for the tool to set current
KEYWORD PARAMETERS:
None
CALLS: ***
_IDLitsys_GetSystem
MODIFICATION HISTORY:
Written by: KDB, RSI, Novemember 2002
Modified:
[Previous]
[Next]
NAME:
itDelete
PURPOSE:
Used to delete a tool in the system from the command line
CALLING SEQUENCE:
itDelete[, idTool]
INPUTS:
idTool - The identifier for the tool to delete. If not provided,
the current tool is used.
KEYWORD PARAMETERS:
None
CALLS: ***
_IDLitsys_GetSystem
MODIFICATION HISTORY:
Written by: KDB, RSI, Novemember 2002
Modified:
[Previous]
[Next]
NAME:
itGetCurrent
PURPOSE:
Returns the current tool in the system.
CALLING SEQUENCE:
idTool = itGetCurrent()
INPUTS:
None
KEYWORD PARAMETERS:
TOOL: Set this keyword to a named variable in which to return the
object reference to the current tool object.
If there is no current tool then a null object is returned.
RETURN VALUE
An identifier for the current tool. If no tool is current,
an empty ('') string is returned.
CALLS: ***
_IDLitsys_GetSystem
MODIFICATION HISTORY:
Written by: KDB, RSI, Novemember 2002
Modified: CT, RSI, Jan 2004: Added TOOL keyword.
[Previous]
[Next]
NAME:
itRegister
PURPOSE:
A procedural method that allows the user to register an item with
the system. This can include tools (the default), visualizations
and user interfaces
PARAMETERS
strName - The name to associate with the class
strClassName - The class name of the tool or if a UI is being
registered, the routine to call.
Keywords:
ANNOTATION: Register an annotation
FILE_READER: Register a File Reader
FILE_WRITER: Register a File Writer
TOOL <default>: Register a tool with the system
VISUALIZATION: Register a Visualization
USER_INTERFACE: Register user interface style
UI_PANEL: Register a UI panel routine and type
UI_SERVICE: Register a UI service with the system.
All keywords are passed to the underlying tool registration system.
CALLS: ***
_IDLitsys_GetSystem
MODIFICATION HISTORY:
Modified: CT, RSI, Jan 2004: Added ANNOTATION, FILE_READER,
FILE_WRITER, USER_INTERFACE keywords.
[Previous]
[Next]
NAME:
itReset
PURPOSE:
A command line routine used to reset the entire tools system in
the current IDL session. It will call the _ResetSystem method on
the underlying system object.
PARAMETERS:
None.
KEYWORDS:
NO_PROMPT - If set, the user is not prompted to verify the reset action.
CALLS: ***
_IDLitsys_GetSystem
[Previous]
[Next]
NAME:
iVolume
PURPOSE:
Implements the iVolume command line interface for the tools sytem.
CALLING SEQUENCE:
iVolume
INPUTS:
vol0, vol1, vol2, vol3 - Three-dimensional arrays of volume data.
Zero, one, two, or four of these channels must be specified.
All of the volume arrays must be of the same dimension.
If no volume data is specified, an empty volume visualization
is created.
KEYWORD PARAMETERS:
RGB_TABLE0, RGB_TABLE1 - [3x256] array of color values.
If not specified, linear gray ramps are used in the volume
visualization. If a two-channel volume is specified, the
volume visualization will use both color tables; otherwise
it uses the first color table.
OPACITY_TABLE0, OPACITY_TABLE1 - [3x256] array of opacity values.
If not specified, linear ramps are used in the volume
visualization. If a two-channel volume is specified, the
volume visualization will use both opacity tables; otherwise
it uses the first opacity table.
VOLUME_DIMENSIONS - A three-element vector that specifies the
volume dimensions in user data coordinates.
VOLUME_LOCATION - A three-element vector that specifies the
volume location in user data coordinates.
IDENTIFIER [out] - The identifier of the created tool.
Keywords accepted by IDLgrVolume may also be specified.
In addition, the following keywords are available:
AUTO_RENDER - Set to 1 to always render the volume. The default is
to not render the volume each time the tool window is drawn.
RENDER_EXTENTS - 0: Do not draw anything around the volume.
1: Draw a wireframe around the volume. 2: Draw a translucent box
around the volume.
RENDER_QUALITY - 1: Low - Renders volume with a stack of 2D texture maps.
2: High - Use IDLgrVolume ray-casting rendering.
SUBVOLUME (or BOUNDS)- Six-element vector [Xmin, Ymin, Zmin, Xmax, Ymax, Zmax]
to specify the subvolume to render.
All other keywords are passed to the tool during creation.
CALLS: ***
IDLitsys_CreateTool
MODIFICATION HISTORY:
Written by: KWS, RSI, February 2003
Modified: