Class TSSnd

java.lang.Object
  extended by TSOpts
      extended by TSData
          extended by TSWrld
              extended by TSSnd
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
TSSRgn, TSSSrc

 class TSSnd
extends TSWrld

.

======================================================================
 Class TSSnd -- Basic-Definition of a 'Sound'-Entry (common)
 ##TSSnd (Eyecatcher)
======================================================================
 


Field Summary
private  TSWrld Chn
           
private  TSQDir Dir
           
protected static java.lang.String IdStr
           
private  java.lang.String Nme
           
private  TSSnd nxt
           
private  int OID
           
private  TSOpts Opt
           
private  int OT
           
private  TSPos Pos
           
private  int SL
           
private  int StF
           
private  int[] Uid
           
private  TSView VId
           
private  int VNr
           
 
Constructor Summary
protected TSSnd()
          .
protected TSSnd(int oid, int ot, int sl)
          .
protected TSSnd(TSSnd csnd, int oid, int sl)
          .
 
Method Summary
protected  boolean $reNew(int oid, int uid)
          .
protected  java.lang.String adjHgt(double d)
          .
protected  boolean chainUiD(TSSnd cSnd)
          .
protected  TSWrld chgChn(TSWrld cS)
          .
protected  java.lang.String chgNme(java.lang.String w)
          .
protected  TSView chgView(TSView nVS)
          .
protected  boolean chkSL(TSOpts cM)
          .
protected  boolean clrOpt(int nr)
          .
protected  TSView clrView(int w)
          .
protected  java.lang.String crDef(int t, int n, boolean me)
          .
protected  java.lang.String crDef(int t, int n, boolean me, int z)
          .
protected  TSPos crPos()
          .
protected  int getCtl(int i)
          .
protected  java.lang.String getItem(int i)
          .
protected  java.lang.String getName(boolean org)
          .
protected static java.lang.String getName(int ot)
          .
protected  int getOpt(int m)
          .
protected  int getTyp()
          .
protected  int getUiD(int t)
          .
protected  boolean isBefore(TSWrld vO)
          .
protected  boolean isEqual(TSWrld vO)
          .
protected  boolean isOpt(int nr)
          .
protected  int nxtUiD(TSQuad cQ)
          .
protected  int renUiD(int nr)
          .
protected  int resOpt(int m)
          .
protected  boolean setOpt(int nr)
          .
protected static int setOT(java.lang.String kw)
          .
protected  TSPos setPos(TSPos cP)
          .
protected  TSQDir setQDir(TSQDir cD)
          .
protected  int setSL(int w)
          .
protected  int setStF(int w)
          .
protected  int setUiD(int uid, int kng)
          .
protected  java.lang.String toStr()
          .
protected  java.lang.String toStr(boolean term)
          .
 
Methods inherited from class TSWrld
addTrI, chgDta, chgTrI, chkMsk, chkTrItmT, crQDir, get$TrI, getVNrDef, setDef
 
Methods inherited from class TSData
addDta, addObj, cr$Obj, get$Obj, getDta, getDta, getFlt, getInt, getInt, getObj, getOpt, getQue, setDta, setDta, setFlt, setInt, setInt, setObj
 
Methods inherited from class TSOpts
$init, chkMsk, clrMsk, clrMsk, cntMsk, cntMsk, fndMsk, getMsk, orMsk, orMsk, prtMsk, resMsk, setMsk, setMsk, tstMsk
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IdStr

protected static final java.lang.String IdStr
See Also:
Constant Field Values

OID

private int OID

Uid

private int[] Uid

OT

private int OT

SL

private int SL

StF

private int StF

Opt

private TSOpts Opt

Pos

private TSPos Pos

Dir

private TSQDir Dir

VId

private TSView VId

VNr

private int VNr

nxt

private TSSnd nxt

Nme

private java.lang.String Nme

Chn

private TSWrld Chn
Constructor Detail

TSSnd

protected TSSnd()
.
 Used options (stored within field 'Opt'):
        0 - Entry is invalid ('Dummy-Entry') Do not handle nor write
        1 -
        2 -
        3 -
        4 -
        7 - Entry is member of 'MveObj'-set
  8 to 23 - Options depend from extended type-definition
 24 to 31 - temporary used options
       24 - moved to other quad -- do NOT renumber
       31 - Entry is already processed
 Definition of mask 'valMsk' (extended objects):
  0 to 14 : not used
       15 : Position (Soundsource)
       16 : TrItemId
       17 : UiD (Soundregion)
       18 : not used
       19 : FileName
       20 : StaticFlags
       21 : Position
       22 : QDirection
       23 : Matrix3x3
       24 : not used
       25 : VDbId
       26 : StaticDetailLevel
 27 to 28 : not used
       29 : UiD (Soundsource)
 30 to 31 : not used
 The bit-definitions of masks 'reqMsk' and 'addMsk' are similar to
 this assignment. However, bit 1 to 14 are individually used and
 bit 31 contains a summary-flag for 'QDirection' and 'Matrix3x3'.
 Index-Definitions from 'TSData' (.):
   0.xx(S) - (Queue) not used
   1.xx(I) - (Queue) not used
 (Compare to sub-objects(object-class) for additional definitions)
=====================================================================
 Constructor: (1) Create default-entry
=====================================================================
  


TSSnd

protected TSSnd(int oid,
                int ot,
                int sl)
.
=====================================================================
 Constructor: (2) Create standard-entry
=====================================================================
  


TSSnd

protected TSSnd(TSSnd csnd,
                int oid,
                int sl)
.
=====================================================================
 Constructor: (3) Create copy-entry from template
=====================================================================
  

Method Detail

$reNew

protected boolean $reNew(int oid,
                         int uid)
.
=====================================================================
 Methode "$reNew"
 Objekt fuer den Wechsel des zugeordneten Quadranten vorbereiten
   Alle als 'eindeutig' geforderten Werte korrigieren
 ##$reNew.TSSnd (Eyecatcher)
=====================================================================
  


adjHgt

protected java.lang.String adjHgt(double d)
.
=====================================================================
 Methode "adjHgt"
 Hoehenwert eines Knotens anpassen
   Ergebniswert muss nicht geprueft werden
 ##adjHgt.TSSnd (Eyecatcher)
=====================================================================
  


chainUiD

protected boolean chainUiD(TSSnd cSnd)
.
=====================================================================
 Methode "chainUiD"
 doppelte UID-Werte miteinander verketten
 Der hier definierte Sound wird an des Ende der bei 'cSnd'
   begonnenen Kette angehaengt.
 ##chainUiD.TSSnd (Eyecatcher)
=====================================================================
  


chgChn

protected TSWrld chgChn(TSWrld cS)
.
=====================================================================
 Methode "chgChn"
 Verkettungswert 'Chn' pflegen (eintragen/aendern oder liefern)
 Methode wird zur Verwaltung einer 'TSChain'-Kette benutzt
 ACHTUNG: Obwohl in Wirklichkeit mit Sound-Objekten gearbeitet wird,
          werden diese ueber die Superklasse 'TSWrld' adressiert.
 ##chgChn.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
chgChn in class TSWrld

chgNme

protected java.lang.String chgNme(java.lang.String w)
.
=====================================================================
 Methode "chgNme"
 neuen aktuellen Dateinamen liefern oder aendern
 wenn w==null: liefern aktuellen Dateinamen (information-Hiding)
 ##chgNme.TSSnd (Eyecatcher)
=====================================================================
  


chgView

protected TSView chgView(TSView nVS)
.
=====================================================================
 Methode "chgView"
 Aktuelle ViewSphere Referenz eintragen/aendern oder liefern
 ##chgView.TSSnd (Eyecatcher)
=====================================================================
  


chkSL

protected boolean chkSL(TSOpts cM)
.
=====================================================================
 Methode "chkSL"
 Check mask using current 'StaticDetailLevel'
 ##chkSL.TSSnd (Eyecatcher)
=====================================================================
  


clrOpt

protected boolean clrOpt(int nr)
.
=====================================================================
 Methode "clrOpt"
 Option aus den Gesamt-Optionen herausloeschen
 liefert den Status der Option VOR dem Loeschen
 ##clrOpt.TSSnd (Eyecatcher)
=====================================================================
  


clrView

protected TSView clrView(int w)
.
=====================================================================
 Methode "clrView"
 Aktuelle ViewSphere Referenz loeschen und durch Viewsphere-Kennung
   ersetzen. Alte Viewsphere Referenz liefern
 ##clrView.TSSnd (Eyecatcher)
=====================================================================
  


crDef

protected java.lang.String crDef(int t,
                                 int n,
                                 boolean me)
.
=====================================================================
 Methode "crDef" (Version 1)
 Zeilendefinition(en) fuer die Ausgabe erzeugen
 Version fuer ALLE GEMEINSAMEN Definitionen
 ##crDef.TSSnd (Eyecatcher)
=====================================================================
  


crDef

protected java.lang.String crDef(int t,
                                 int n,
                                 boolean me,
                                 int z)
.
=====================================================================
 Methode "crDef" (Version 2)
 Dummy-Definition mit Zusatzwert
 Version fuer ALLE GEMEINSAMEN Definitionen
 ##crDef.TSSnd (Eyecatcher)
=====================================================================
  


crPos

protected TSPos crPos()
.
=====================================================================
 Methode "crPos"
 Information-Hiding: Positionswerte als TSPos-Objekt liefern
 Achtung: Es wird eine (shallow-)Kopie geliefert, sodass die Attribute
          dieses Objektes (testweise) modifiziert werden koennen,
          ohne das Basisobjekt zu beeinflussen
 ##crPos.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
crPos in class TSWrld

getCtl

protected int getCtl(int i)
.
=====================================================================
 Method "getCtl" (This dummy-method is normally overlayed)
 ##getCtl.TSSnd (Eyecatcher)
=====================================================================
  


getItem

protected java.lang.String getItem(int i)
.
=====================================================================
 Method "getItem" (This dummy-method is normally overlayed)
 ##getItem.TSSnd (Eyecatcher)
=====================================================================
  


getName

protected java.lang.String getName(boolean org)
.
=====================================================================
 Methode "getName"
 liefern der Bezeichnung des Objekt-Typs
 Diese Methode wird benutzt wenn in der abgeleiteten Klasse
  keine Methode 'getName()' definiert ist. Da dies (normalerweise)
  nicht der Fall ist, wird diese Methode nur fuer Objekte der
  Basisklasse verwendet. Diese haben keinen Namen.
 ##getName.TSSnd (Eyecatcher)
=====================================================================
  


getName

protected static java.lang.String getName(int ot)
.
=====================================================================
 Methode "getName" (statisch)
 liefern der Bezeichnung eines Objekt-Typs
 ##getName.TSSnd (Eyecatcher)
=====================================================================
  


getOpt

protected int getOpt(int m)
.
=====================================================================
 Methode "getOpt"
 Gesamt-Optionen maskiert liefern
 Maske '-1' (=0xFFFFFFFF) liefert ALLE Optionen
 Die gespeicherte Maske wird NICHT veraendert
 ##getOpt.TSSnd (Eyecatcher)
=====================================================================
  


getTyp

protected int getTyp()
.
=====================================================================
 Methode "getTyp"
 Information-Hiding: Objekt-Typ liefern
 ##getTyp.TSSnd (Eyecatcher)
=====================================================================
  


getUiD

protected int getUiD(int t)
.
=====================================================================
 Methode "getUiD"
 Information-Hiding: aktuelle UID gemaess UiD-Typ liefern
 ##getUiD.TSSnd (Eyecatcher)
=====================================================================
  


isBefore

protected boolean isBefore(TSWrld vO)
.
=====================================================================
 Methode "isBefore"
 Methode zum sortieren der Sound-Eintraege
 Diese Methode wird durch 'TSChain' benutzt und gefordert
 ##isBefore.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
isBefore in class TSWrld

isEqual

protected boolean isEqual(TSWrld vO)
.
=====================================================================
 Methode "isEqual"
 Methode zum pruefen der Sound-Eintraege auf Gleichheit
 Diese Methode wird durch 'TSChain' benutzt und gefordert
 ##isEqual.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
isEqual in class TSWrld

isOpt

protected boolean isOpt(int nr)
.
=====================================================================
 Methode "isOpt"
 Pruefung ob Option aktiviert
 Methode liefert 'true' wenn das Optionenbit gesetzt ist
 ##isOpt.TSSnd (Eyecatcher)
=====================================================================
  


nxtUiD

protected int nxtUiD(TSQuad cQ)
.
=====================================================================
 Methode "nxtUiD"
 UID-Wert(orginal) mit Maximalwert neu setzen und korrigieren
 Routine arbeitet auf 'Uid[1]', 'Uid[2]'
 ##nxtUiD.TSSnd (Eyecatcher)
=====================================================================
  


renUiD

protected int renUiD(int nr)
.
=====================================================================
 Methode "renUiD"
 UID-Wert(neu) mit neu erstellter UiD-Kennung setzen
 Routine arbeitet auf 'Uid2'
 Wenn 'nr' negativ ist, wird 'nr' unveraendert zurueckgegeben und
   die UiD nicht veraendert
 Routine arbeitet auf 'Uid[2]'
 ##renUiD.TSSnd (Eyecatcher)
=====================================================================
  


resOpt

protected int resOpt(int m)
.
=====================================================================
 Methode "resOpt"
 Option(en) aus den Gesamt-Optionen loeschen
 Methode liefert eine Maske der zurueckgesetzten Optionen
 ##resOpt.TSSnd (Eyecatcher)
=====================================================================
  


setOpt

protected boolean setOpt(int nr)
.
=====================================================================
 Methode "setOpt"
 Option den Gesamt-Optionen hinzufuegen
 liefert den Status der Option VOR dem setzen
 ##setOpt.TSSnd (Eyecatcher)
=====================================================================
  


setOT

protected static int setOT(java.lang.String kw)
.
=====================================================================
 Methode "setOT" (statisch)
 Objekt-Typ pruefen und liefern
 Wird ausschliesslich in 'chgSnd()' benutzt!
 ##setOT.TSSnd (Eyecatcher)
=====================================================================
  


setPos

protected TSPos setPos(TSPos cP)
.
=====================================================================
 Methode "setPos"
 Positionsobjekt speichern
 ##setPos.TSSnd (Eyecatcher)
=====================================================================
  


setQDir

protected TSQDir setQDir(TSQDir cD)
.
=====================================================================
 Methode "setQDir"
 Richtungsdefinition eines Objektes speichern
 ##setQDir.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
setQDir in class TSWrld

setSL

protected int setSL(int w)
.
=====================================================================
 Methode "setSL"
 Set new value for 'StaticDetailLevel'
 Value is chandes in every case and OLD one is returned.
 Value can be ONLY resumed if used twice: 'setSL(x=setSL(0));'
 Attention: This method marks 'StaticDetailLevel' as 'set explicitely'
 Attention: New value may be modified to match the allowed range.
 ##setSL.TSSnd (Eyecatcher)
=====================================================================
  


setStF

protected int setStF(int w)
.
=====================================================================
 Methode "setStF"
 Set new value for 'StaticFlags'
 Value can be resumed if used twice: 'setStF(x=setStF(0));'
 ##setStF.TSSnd (Eyecatcher)
=====================================================================
  


setUiD

protected int setUiD(int uid,
                     int kng)
.
=====================================================================
 Methode "setUiD"
 aktuelle UID initialisieren und eintragen
 Achtung: Eine einmal eingetragene UiD kann hiermit NICHT mehr
          ueberschrieben werden
 Achtung: UiD-Kennzeichen ist BEREITS eingetragen
 ##setUiD.TSSnd (Eyecatcher)
=====================================================================
  


toStr

protected java.lang.String toStr()
.
=====================================================================
 Method "toStr"
 Build a string-representation of all values of this class
 ##toStr.TSSnd (Eyecatcher)
=====================================================================
  

Overrides:
toStr in class TSWrld

toStr

protected final java.lang.String toStr(boolean term)
.
=====================================================================
 Method "toStr"
 Build a string-representation of all values of this class
 ##toStr.TSSnd (Eyecatcher)
=====================================================================