 |
| |
A symbol object represents a graphical element that is plotted relative to a particular position.
IDLgrSymbol::CleanupThe IDLgrSymbol:: Cleanup procedure method performs all cleanup on the object. IDLgrSymbol is described above.
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.
IDLgrSymbol::GetPropertyThe IDLgrSymbol:: GetProperty procedure method retrieves the value of a property or group of properties for the symbol. IDLgrSymbol is described above.
Any keyword to IDLgrSymbol::Init
Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.
IDLgrSymbol::InitThe IDLgrSymbol:: Init function method initializes the plot symbol. IDLgrSymbol is described above.
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.
Obj = OBJ_NEW('IDLgrSymbol' [Data] )
Result =
Obj
->
[IDLgrSymbol::]
Init(
[Data]
) (
In a subclass' Init method only
.)
Either an integer value from the list shown below, or an object reference to either an IDLgrModel object or atomic graphic object.
Use one of the following scalar-represented internal default symbols:
If an instance of the IDLgrModel object class or an atomic graphic object is used, the object tree is used as the symbol. For best results, the object should fill the domain from -1 to +1 in all dimensions. The pre-defined symbols listed above are all defined in the domain -1 to +1.
Properties retrievable via IDLgrSymbol::GetProperty
Set this keyword to the color used to draw the symbol. The color may be specified as a color lookup table index or as an RGB vector. The default color is the color of the object for which this symbol is being used.
Set this keyword to specify a symbol. This keyword is equivalent to the Data argument.
Set this keyword equal to a string containing the name associated with this object. The default is the null string, ' '.
Set this keyword to a one-, two-, or three-element vector describing the X, Y, and Z scaling factors to be applied to the symbol. The default is [1.0, 1.0, 1.0].
Set this keyword to an integer value between 1 and 10, specifying the line thickness to used to draw any lines that make up the symbol, in pixels. The default is one pixel.
Set this keyword to a value of any type. You can use this "user value" to contain any information you wish. Remember that if you set the user value equal to a pointer or object reference, you should destroy the pointer or object reference explicitly when destroying the object it is a user value of.
IDLgrSymbol::SetPropertyThe IDLgrSymbol:: SetProperty procedure method sets the value of a property or group of properties for the symbol. IDLgrSymbol is described above.
Any keyword to IDLgrSymbol::Init