1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!-- HTML file produced from file: UserManual.tex --
-- using Hyperlatex v 2.3.1 (c) Otfried Cheong--
-- on Emacs 21.1 (patch 4) "Arches" XEmacs Lucid, Sun Apr 30 20:50:04 2000 -->
<HEAD>
<TITLE>Tao User Manual -- Accessing the Internal Attributes of an Instrument</TITLE>
<link rel=stylesheet href="../../taomanual.css" type="text/css">
</HEAD><BODY BACKGROUND="bg.gif">
<table width="500" border="0" align="left" cellspacing="2" cellpadding="2"><tr><td class="nav" valign="top"><!-- top panel --><A HREF="UserManual_85.html"><IMG ALT="Up" ALIGN=BOTTOM BORDER=0 SRC="up.gif"></A>
<BR><A HREF="UserManual_85.html">Instrument Methods grouped by Function</A><BR><IMG width="167" height="1" SRC="trans1x1.gif">
</td><td class="nav" valign="top"><A HREF="UserManual_88.html"><IMG ALT="Back" ALIGN=BOTTOM BORDER=0 SRC="back.gif"></A>
<BR><A HREF="UserManual_88.html">Graphically Placing Instruments</A><BR><IMG width="167" height="1" SRC="trans1x1.gif">
</td><td class="nav" valign="top"><A HREF="UserManual_90.html"><IMG ALT="Forward" ALIGN=BOTTOM BORDER=0 SRC="forward.gif"></A>
<BR><A HREF="UserManual_90.html">Setting the Internal Attributes of an Instrument</A><BR><IMG width="167" height="1" SRC="trans1x1.gif">
</td></tr><!-- end top panel --><tr><td colspan="3" class="main"><!-- main text --><br><br>
<H3>Accessing the Internal Attributes of an Instrument</H3>
This set of methods allow the internal attributes of an instrument
to be inspected. Please note that some of these methods are only listed
for completeness. In practice they are not of much use in the
average <B>Tao</B> script.
<P><PRE>
getName()
getMagnification()
getWorldX()
getWorldY()
getXMax()
getYMax()
getXFrequency()
getYFrequency()
</PRE>
<P>The <CODE>getName</CODE><A NAME="1"> method</A> returns a string containing the name
of the instrument. The <CODE>getMagnification</CODE><A NAME="2"> method</A> returns
the current factor by which the visual amplitude of the waves in the
instrument are being magnified. The two methods <CODE>getWorldX</CODE><A NAME="3">
and</A> <CODE>getWorldY</CODE><A NAME="4"> return</A> the world coordinates of the bottom
left hand corner of the bounding box around the instrument (i.e. the
position in the <I>xy</I> plane). The <CODE>getXMax</CODE><A NAME="5"> and</A>
<CODE>getXMax</CODE><A NAME="6"> methods</A> return the <I>N-1</I> where <I>N</I> is the
width or height of the instrument in cells respectively.
<P>The only two methods which should be of any use in the average <B>Tao</B>
script are <CODE>getXFrequency</CODE><A NAME="7"> and</A> <CODE>getYFrequency</CODE><A NAME="8">.</A>
These return the pitch values which were passed in when the instrument
was created, but converted to Hertz, regardless of the initial pitch
format used.
<P>
<BR></td></tr><!-- end main text --><tr><td class="nav" align="left" valign="top"><!-- bottom matter --><A HREF="UserManual_85.html"><IMG ALT="Up" ALIGN=BOTTOM BORDER=0 SRC="up.gif"></A>
<BR><A HREF="UserManual_85.html">Instrument Methods grouped by Function</A><BR><IMG width="167" height="1" SRC="trans1x1.gif">
</td><td class="nav" align="left" valign="top"><A HREF="UserManual_88.html"><IMG ALT="Back" ALIGN=BOTTOM BORDER=0 SRC="back.gif"></A>
<BR><A HREF="UserManual_88.html">Graphically Placing Instruments</A><BR><IMG width="167" height="1" SRC="trans1x1.gif">
</td><td class="nav" align="left" valign="top"><!-- bottom matter --><A HREF="UserManual_90.html"><IMG ALT="Forward" ALIGN=BOTTOM BORDER=0 SRC="forward.gif"></A>
<BR><A HREF="UserManual_90.html">Setting the Internal Attributes of an Instrument</A>
<IMG width="167" height="1" SRC="trans1x1.gif">
</td></tr><!-- end bottom matter -->
<tr><td colspan="3" class="addr"><!-- bottom panel --><ADDRESS><FONT SIZE=-1>©1999,2000 Mark Pearson
<A HREF="mailto:m.pearson@ukonline.co.uk">m.pearson@ukonline.co.uk</A> April 30, 2000</ADDRESS><BR></td></tr><!-- end bottom panel --></table></BODY></HTML>
|